Sign in
latestOpenAPI 3.0.02026-08-1610635191.3 KB

355890b6b4cc

Deep Research

Perform deep research on a given query

Conducts advanced research on the provided text query and returns results in the specified output format

post/deep-research/research

Request body

textstring required

The research query text

outputType'text' | 'json' required

The format of the output result. When set to json, the response is serialized JSON.

jsonFormatstring

Optional instructions or template describing the JSON structure to generate.

provider'gemini' | 'openai'

The AI provider to use for research (defaults to gemini)

projectIdsstring[]

Optional array of project IDs to add context from their descriptions

filesstring[]

Optional array of file URLs or uploaded file IDs (from /files) to attach to the research request

callbackDatastring

Optional callback data to be returned with the response

isScheduledboolean

If true, creates a recurring schedule instead of a one-time request

dailyCountinteger

Number of times per day to execute the research (default 1, only used when isScheduled is true)

scheduleEndDatestring date-time

Optional end date for the schedule (only used when isScheduled is true). If not provided, schedule runs indefinitely.

Example request

{
  "text": "What are the latest developments in artificial intelligence?",
  "outputType": "json",
  "jsonFormat": "{\n  \"summary\": \"\",\n  \"keyFindings\": [],\n  \"sources\": []\n}\n",
  "provider": "gemini",
  "projectIds": [
    "proj-123",
    "proj-456"
  ],
  "files": [
    "https://example.com/reference.pdf",
    "2c9fe88f-d3e2-41a8-9156-76c5e34dbfdd"
  ],
  "callbackData": "user-specific-data",
  "dailyCount": 2,
  "scheduleEndDate": "2024-12-31T23:59:59Z"
}

Response

Research request or schedule submitted successfully

OR

Example response

{
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}