Platform jobs API
The platform jobs API provides a durable, priority-based background job queue. You can enqueue provisioning and chat jobs that run asynchronously with automatic retries and status tracking.These endpoints are backend-internal and require a valid internal API key passed in the
Authorization header. Web clients should use the Jobs API proxy endpoints instead.Job model
Every job follows a common lifecycle:- A job is created with status
queued. - A worker claims the job and moves it to
running. - On success the job moves to
completedwith aresultpayload. - On failure the job is retried (up to
maxAttempts) or moves tofailed.
running state for more than ten minutes are automatically requeued.
Job types
Job statuses
Enqueue a provision job
202 Accepted status.
Request body
Response (202)
Errors
Enqueue a chat job
202 Accepted status.
Request body
Response (202)
Errors
Get a job
Path parameters
Response
Job response fields
Errors
Get job metrics
Response
Errors
Retry behavior
Failed jobs are automatically retried with exponential backoff:
Provision jobs allow up to five attempts. Chat jobs allow up to three attempts. After exhausting all attempts, the job status is set to
failed.