Create a deep-research job

POST/v1/research/jobs

Authorization

bearerAuth

AuthorizationBearer <token>

API token issued from the dashboard (Settings → API Tokens). Sent as Authorization: Bearer <token>.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

query*string

Length1 <= length <= 5000

jobType*string

Value in"quick_search" | "quick_deep" | "full_deep" | "academic"

Response Body

`application/json`

cURL

curl -X POST "https://example.com/research/jobs" \  -H "Content-Type: application/json" \  -d '{    "query": "string",    "jobType": "quick_search"  }'

{
  "success": true,
  "job": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "jobType": "quick_search",
    "status": "pending",
    "query": "string",
    "progress": -9007199254740991,
    "currentStep": "string",
    "stepsCompleted": -9007199254740991,
    "stepsTotal": -9007199254740991,
    "findings": "string",
    "learnings": [
      "string"
    ],
    "citations": [
      {
        "text": "string",
        "url": "string",
        "title": "string"
      }
    ],
    "createdAt": "2019-08-24T14:15:22Z",
    "startedAt": "2019-08-24T14:15:22Z",
    "completedAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

{
  "error": "validation_failed",
  "message": "string",
  "issues": null
}

{
  "error": "unauthorized"
}

{
  "error": "validation_failed",
  "message": "string",
  "issues": null
}

{
  "success": false,
  "error": "API key lacks write permission"
}

{
  "error": "validation_failed",
  "message": "string",
  "issues": null
}

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

402application/json

403application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`