v1

latestOpenAPI 3.0.02026-07-223589127.1 KB

Deep Research

Start deep research

Start a deep research job with a prompt and JSON Schema. The response includes an operation ID and poll URL for retrieving the structured result.

post/api/deep-research

Headers

Idempotency-Keystring

Prevents duplicate work if you retry the same request with the same key.

Request body

promptstring required

Research instructions.

schemaobject required

JSON Schema that defines the dynamic shape of result.data returned after the operation completes.

modelstring

Optional model override.

urlsstring[]

Optional seed URLs to prioritize during research.

maxCreditsinteger

Maximum credits to spend. Must match budget.maxCredits when both are provided.

enrichboolean

Set false to disable server-side schema enrichment and fill exactly the supplied schema. Closed schemas (additionalProperties:false) are never enriched.

confirmboolean

Set true to continue after a confirmation_required estimate warning.

Example request

{
  "prompt": "Research AI CRM competitors",
  "schema": {
    "type": "object",
    "properties": {
      "competitors": {
        "type": "array"
      }
    }
  }
}

Response

Research job accepted. Poll the returned URL for status and results.

idstring required

operationIdstring required

status'queued' required

pollUrlstring required