switchx

Get Job Status

Poll the status of a SwitchX job.

get/v1/switchx/generations/{job_id}

Path parameters

job_idstring required

Response

Successful Response

idstring required

Job identifier (swx_...)

statusstring required

in_queue, processing, completed, or failed

progressinteger nullable

Progress percentage (0-100)

generation_typestring nullable

'image' or 'video'

alpha_modestring nullable

'auto', 'fill', 'custom', or 'select'

seedinteger nullable

Random seed used for this generation (always present after job creation)

errorstring nullable

Error message (present when status is failed)

created_atstring nullable

ISO 8601 timestamp when the job was created

modified_atstring nullable

ISO 8601 timestamp of the last status change

completed_atstring nullable

ISO 8601 timestamp when the job completed or failed

Example response

{
  "progress": 72,
  "webhook": {
    "attempts": 1
  }
}

Changes

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