ReferenceCompany search

Start Company Search

Begin a company search workflow with a natural-language prompt.

Returns a thread_id for status polling, continue and stop.

POST
/api/v1/search/workflow/start

Authorization

ApiKeyAuth
x-api-key<token>

A platform key (ck_live_…). Mint one in the console under Settings → API Keys.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/api/v1/search/workflow/start" \  -H "Content-Type: application/json" \  -d '{    "prompt": "Find Series B SaaS companies in the US",    "list_name": "Q3 prospects",    "list_description": "Series B SaaS companies",    "search_mode": "fast"  }'
{  "success": true,  "message": "string",  "thread_id": "string",  "status": "string"}
Was this page helpful?
Report an issue