Core concepts
Execution flows
CSV download
- Start a search with
POST /search/start-deep-searchand save thetask_id. - Poll
GET /search/status/{task_id}untilstatusiscompleted. The response includesresource_handle_id. Any status other thanrunningorcompletedmeans the search stopped; see Task statuses. - Request a signed URL with
GET /search/downloadand fetch the CSV. The URL expires after 15 minutes.
Paginated JSON
- Start a search with
output_mode: "query_only"and save thetask_id. - Poll
GET /search/status/{task_id}untilstatusiscompleted, then readsearch_id. - Page through results with
POST /search/query, sending eachnext_cursoruntilhas_moreisfalse. Sendmax_resultsagain on the first request; see Replay a saved search. - Optionally generate a CSV from the same
search_idwithPOST /search/export.
Quick start
For new integrations, see Deep Search Overview.