Skip to main content
POST
Queue Chat

Authorizations

Authorization
string
header
required

Authenticate with an API key (prefixed ui_sk_) or a JWT token from the dashboard.

Headers

Idempotency-Key
string
required
Required string length: 1 - 200
X-UI-Organization-ID
string | null

Platform admins only: choose an organization for scoped reads and writes. Required to change another organization's study or use its wallet.

Maximum string length: 128

Path Parameters

session_id
string<uuid>
required

Body

application/json
prompt
string
required
Minimum string length: 1
parent_job_id
string<uuid> | null

Optional completed chat job in this session for a follow-up.

include_synthetic
boolean
default:false

Response

Successful Response

job_id
string
required
status
enum<string>
required
Available options:
pending,
running,
succeeded,
failed
completed
boolean
required

True when work has finished successfully

session_id
string<uuid>
required
poll_url
string
required
result_url
string | null

Fetch the created resource after success

total_count
integer | null

Requested participant count for a batch

error
string | null

A safe failure summary; internal details are never returned

result
HubJobResult · object | null