Sign in
latestOpenAPI 3.0.02026-08-1610635191.3 KB

355890b6b4cc

Deep Research

Get a specific deep research request by ID

Retrieves a single deep research request by its unique ID

get/deep-research/research/{id}

Path parameters

idstring required

The ID of the deep research request to retrieve

Response

Successfully retrieved deep research request

idstring

The request ID

requestedOnstring date-time

When the request was made

succeededOnstring date-time

When the request was completed

statusinteger

Request status (0=pending, 5=processing, 100=completed)

errorOnstring date-time

When the error occurred

errorMessagestring

Error message if request failed

errorCodeinteger

Error code if request failed

promptstring

The research query text

outputTypestring

Output format used for the response (text or json)

jsonFormatstring

JSON formatting instructions applied when outputType is json

isScheduleTemplateboolean

True if this item is a schedule template rather than an executed request

scheduleIdstring

The ID of the schedule template

dailyCountinteger

Number of times per day this schedule will execute

scheduleEndDatestring date-time

End date for the schedule, or null if it runs indefinitely

lastScheduleExecutionOnstring date-time

The most recent time this schedule executed

nextScheduleExecutionOnstring date-time

The next scheduled execution time

responseTextstring

The research result content. When outputType is json, this value is a serialized JSON string.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "requestedOn": "2024-01-15T10:30:00Z",
  "succeededOn": "2024-01-15T10:35:00Z",
  "status": 100,
  "prompt": "What are the latest developments in artificial intelligence?",
  "outputType": "json",
  "jsonFormat": "{\"summary\":\"\",\"keyInsights\":[]}",
  "isScheduleTemplate": true,
  "scheduleId": "550e8400-e29b-41d4-a716-446655440000",
  "dailyCount": 2,
  "scheduleEndDate": "2024-12-31T23:59:59Z",
  "lastScheduleExecutionOn": "2024-01-16T09:00:00Z",
  "nextScheduleExecutionOn": "2024-01-16T12:00:00Z",
  "responseText": "{\"summary\":\"AI advancements\",\"keyInsights\":[\"...\"]}"
}