Sign in

v1

latestOpenAPI 3.1.02026-07-26194149.1 KB
Research

Create A Task

Launches a one-time research task on the web.

post/v1/research/tasks

Request body

output_schemaobject nullable

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

used_deprecated_task_specboolean
querystring required
    String describing the research task in natural language.
user_timezonestring

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

user_locationstring nullable

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

skip_emailboolean
    If true, email notifications will be skipped and only webhook notifications will be sent.
    Default: true (sends webhooks only).
webhook_urlstring nullable

Optional webhook URL to receive results when the research task completes

webhook_format'scout' | 'slack' | 'zapier'

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

Example request

{
  "output_schema": {
    "items": {
      "properties": {
        "title": {
          "description": "Title of the development",
          "type": "string"
        },
        "summary": {
          "description": "Brief summary",
          "type": "string"
        },
        "source_url": {
          "description": "URL for more details",
          "type": "string"
        }
      },
      "type": "object"
    },
    "type": "array"
  },
  "query": "What are the latest developments in quantum computing from the past week?",
  "user_timezone": "America/Los_Angeles",
  "user_location": "San Francisco, CA, US",
  "skip_email": true,
  "webhook_url": "https://example.com/webhook",
  "webhook_format": "scout"
}

Response

Successful Response

task_idstring required

Unique identifier for this research task

view_urlstring required

URL to view task progress and results

status'queued' | 'running' | 'succeeded' | 'failed' required

Current status of the research task

webhook_urlstring nullable

Echoes the webhook URL configured for this task, if provided