Skip to main content
POST

Advanced Example

Configure structured output with output_schema to receive data in a specific JSON schema format, and optionally add webhook notifications.

Authorizations

x-api-key
string
header
required

Body

application/json
query
string
required
Example:

"What are the latest developments in quantum computing from the past week?"

output_schema
Output Schema · object | null

JSON Schema for structured output. Takes precedence over task_spec if both provided.

Example:
task_spec
TaskSpec · object | null
deprecated

Deprecated but still supported. Use output_schema instead.

used_deprecated_task_spec
boolean
default:false
user_timezone
string
default:America/Los_Angeles

User's timezone for contextual awareness (e.g. 'America/Los_Angeles')

Example:

"America/Los_Angeles"

user_location
string | null
default:San Francisco, CA, US

User's coarse location in the format: city, region_code, country_name

Example:

"San Francisco, CA, US"

skip_email
boolean
default:true
Example:

true

webhook_url
string | null

Optional webhook URL to receive results when the research task completes

Example:

"https://example.com/webhook"

webhook_format
enum<string>
default:scout

Webhook payload format. Slack incoming webhook URLs require 'slack'.

Available options:
scout,
slack,
zapier
Example:

"scout"

Response

Successful Response

Response for creating a research task.

task_id
string
required

Unique identifier for this research task

view_url
string
required

URL to view task progress and results

status
enum<string>
required

Current status of the research task

Available options:
queued,
running,
succeeded,
failed
webhook_url
string | null

Echoes the webhook URL configured for this task, if provided