latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-201,3412,1385.0 MB

3fdc16374d70

Research

Start research task

Starts a deep research task that runs multiple searches, reads sources, and synthesizes an answer with citations.

Synchronous mode (default)

When background is false or omitted, the request blocks until the research completes and returns the answer with citations. This can take up to 120 seconds depending on research_effort.

Asynchronous mode

When background is true, the request returns immediately with a task_id and status: pending. Poll GET /web_search/research/{task_id} to check when the research completes and retrieve the answer.

post/web_search/research

Request body

backgroundboolean

When true, the research runs asynchronously. The response returns a task_id immediately instead of waiting for the result. Poll GET /web_search/research/{task_id} to check status.

max_sourcesinteger

Maximum number of sources to use.

querystring required

The research question or topic.

research_effort'lite' | 'standard' | 'deep'

Research depth level. lite is fastest, deep is most thorough.

Example request

{
  "max_sources": 20,
  "query": "Compare the performance of RAG vs fine-tuning for domain-specific QA",
  "research_effort": "standard"
}

Response

Research response. Shape depends on background:

  • Synchronous (background false/unset): returns answer + citations.
  • Asynchronous (background true): returns task_id + status.

Example response

{
  "data": {
    "answer": "RAG and fine-tuning serve different purposes..."
  }
}