Skip to main content
POST
Start Deep Search (Async)

Headers

x-api-key
string | null

Body

application/json

Request to start an agentic search workflow.

query
string
required

Natural-language search query.

mode
enum<string>
default:people

Search mode: 'people' or 'company'.

Available options:
people,
company
max_results
integer
default:1000

Maximum number of results to return across pages.

search_id
string | null

Optional client-supplied search ID for idempotent retries.

output_mode
enum<string>
default:csv

Output mode: 'csv' to export, 'query_only' to return parsed query only.

Available options:
csv,
query_only
exclude_public_ids
string[] | null

People-mode inline identifiers to exclude from results, applied as a post-filter. Accepts LinkedIn public IDs or profile URLs. For company searches, use exclude_entity_ids. Max 1000.

Maximum array length: 1000
exclude_entity_ids
string[] | null

Inline identifiers to exclude from results, applied as a post-filter. People mode: LinkedIn public IDs or profile URLs. Company mode: numeric LinkedIn company IDs, company URLs/slugs, or exact website domains (values that resolve to no or multiple companies are ignored). Max 1000.

Maximum array length: 1000
exclude_list_ids
string[] | null

Saved exclusion-list IDs to apply as a post-filter. Each list's entity type must match the search mode (person lists for people searches, company lists for company searches). Max 5 (10 for organizations with extended exclusion limits).

Maximum array length: 10

Response

Successful Response

Response for starting an agentic search.

task_id
string
required

Async task ID; poll for status with this value.

status
string
required

Initial task status, typically 'queued'.

message
string
required

Human-readable status message.