Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

API key passed as a Bearer token in the Authorization header.

Headers

AiQL-Workspace
string
required

ID of the workspace the request operates on.

Body

application/json
content
string
required

Natural-language content of the query.

Response

Successful Response

id
string
required

Unique identifier of the query.

content
string
required

Natural-language content of the query.

status
string
required

Status of the query: PENDING, PROCESSING, PROCESSED, or FAILED.

output
string | null

Result the query produced.

steps
(QueryTextStep · object | QueryToolStep · object)[]

Ordered steps taken while working toward the final output. Each step is either an assistant text message ({"text": ...}) or a tool invocation ({"tool": ...}). Reasoning parts, tool arguments, and tool outputs are not included, and the final output is not repeated.