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}

Get async job status

cURL

curl --request GET \
  --url https://app.gc.ai/api/external/v1/jobs/{id} \
  --header 'Authorization: <api-key>'

200

{
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "result": "When reviewing a software license agreement, key terms to examine include:\n\n1. **License Grant** - Understand the scope of rights granted...",
    "chat_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "error": {
    "code": "<string>",
    "message": "<string>"
  },
  "created_at": "<string>",
  "completed_at": "<string>"
}

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

200

application/json

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 · required

Completion payload when the job has succeeded

Show child attributes

error · object · required

Failure payload when the job has failed

Show child attributes

created_at · string · required

ISO 8601 creation timestamp

completed_at · string | null · required

ISO 8601 completion timestamp, or null when not terminal