API ReferenceResearch

Create a Research Object

Start a new research job using a query and optional file IDs.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
querystringRequired
Primary research question or instruction.
fileslist of stringsOptional
IDs of previously uploaded files to include.
compute_unitsintegerOptional1-10Defaults to 1
Optional compute budget for the job. Defaults to 1.
system_promptstringOptional
Optional system prompt to steer the assistant.

Response

Research job accepted.
idstringformat: "uuid"
Research job identifier.
statusenum
Current status of the research job.

Errors

400
Bad Request Error
401
Unauthorized Error
429
Too Many Requests Error
500
Internal Server Error