Skip to main content
GET
/
v1
/
jobs
/
{jobId}
Get generation job status
curl --request GET \
  --url https://api.alakazam.gg/v1/jobs/{jobId} \
  --header 'Authorization: Bearer <token>'
{
  "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "phase": "<string>",
  "progress": 123,
  "worldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "error": "<string>",
  "schemaVersion": "1.0"
}

Authorizations

​
Authorization
string
header
required

An app API key, e.g. Authorization: Bearer sk_live_…. Secret (sk_) for writes/sessions; publishable (pk_) for read/embed.

Path Parameters

​
jobId
string<uuid>
required

Response

Job status

A durable async generation job (returned by async create + GET /v1/jobs/{jobId}).

​
jobId
string<uuid>
​
status
enum<string>
Available options:
queued,
running,
succeeded,
failed,
cancelled
​
phase
string | null
​
progress
number

0–1.

​
worldId
string<uuid> | null

Set when the job succeeds.

​
error
string | null
​
schemaVersion
string
Example:

"1.0"