Async Jobs

Get async job status

Poll an async API job created by endpoints like POST /chat/completions.

Use the job_id returned by a 202 Accepted response to check whether the job is still pending or has reached a terminal state.

get/jobs/{id}

Request

Path parameters

idstring uuid required

The async job ID

Query parameters

waitinteger nullable

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.

Headers

Preferstring

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

Response

Job found and currently in a terminal state

job_idstring uuid required

Async job identifier

kind'chat/completions' required

Stable job kind for this endpoint

status'pending' | 'running' | 'succeeded' | 'failed' | 'canceled' required

Current job status

created_atstring required

ISO 8601 creation timestamp

completed_atstring nullable required

ISO 8601 completion timestamp, or null when not terminal

Example response

{
  "result": {
    "result": "When reviewing a software license agreement, key terms to examine include:\n\n1. **License Grant** - Understand the scope of rights granted...",
    "chat_url": "https://app.gc.ai/chat/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "judge_approved_steps": [
      "projects_update"
    ],
    "skipped_steps": [
      "projects_create"
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.