Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

API key or UI session JWT passed as a Bearer token.

Headers

AiQL-Workspace
string
required

ID of the workspace the request operates on.

Body

application/json
model
string
required

Interaction mode: ask, reason, or build.

messages
ChatMessage · object[]
required

OpenAI-style chat messages. The last user message is the prompt.

stream
boolean
default:false
n
integer | null
default:1

Response

Successful Response

id
string
required
created
integer
required
model
string
required
choices
ChatCompletionChoice · object[]
required
usage
ChatCompletionUsage · object
required
object
string
default:chat.completion
Allowed value: "chat.completion"