Skip to main content
GET
Get async job status

Authorizations

Authorization
string
header
required

API key for authentication. Format: gcai_xxxxxxxxx

Create API keys in the GC AI app under Settings → API.

Headers

Prefer
string

Optional RFC 7240 wait preference, for example wait=0. If both this header and the wait query parameter are supplied, they must match.

Example:

"wait=0"

Path Parameters

id
string<uuid>
required

The async job ID

Query Parameters

wait
integer | null

Optional long-poll wait time in seconds. Use 0 for fire-and-forget behavior. If both wait and Prefer: wait=... are supplied, they must match. Values above 90 are clamped.

Required range: x >= 0
Example:

0

Response

Job found and currently in a terminal state

job_id
string<uuid>
required

Async job identifier

kind
enum<string>
required

Stable job kind for this endpoint

Available options:
chat/completions
status
enum<string>
required

Current job status

Available options:
pending,
running,
succeeded,
failed,
canceled
result
object | null
required

Completion payload when the job has succeeded

error
object | null
required

Failure payload when the job has failed

created_at
string
required

ISO 8601 creation timestamp

completed_at
string | null
required

ISO 8601 completion timestamp, or null when not terminal