Skip to main content
POST
Cancel a job

Authorizations

Authorization
string
header
required

A Voyager API key from https://voyager.so/dashboard/api.

Headers

Idempotency-Key
string | null

Accepted and validated; a cancel is idempotent itself.

Path Parameters

job_id
string
required

Response

Successful Response

id
string
required

job_…

type
string
required

image, video, speech, music, sound_effect or 3d.

model
string | null
required

The model that ran (or will run) the job.

operation
string | null
required

e.g. text-to-image, edit, image-to-video, tts.

status
enum<string>
required

queued, running, succeeded, failed or canceled.

Available options:
queued,
running,
succeeded,
failed,
canceled
input
Input · object
required

The job's input, as sent.

outputs
JobOutput · object[]
required

The files the job made, once it succeeded.

credits
JobCredits · object
required

What the job is expected to cost and what it was charged.

error
JobError · object | null
required

Why the job failed or was canceled.

metadata
Metadata · object
required

The metadata sent with the job, echoed as is.

created_at
string<date-time> | null
required

When it was created (ISO 8601).

started_at
string<date-time> | null
required

When the job started running (ISO 8601); null while queued.

completed_at
string<date-time> | null
required

When the job reached a terminal status (ISO 8601); null until then.

poll_after_ms
integer | null
required

While active: when to poll again.

Links to read and cancel the job.

object
string
default:job

Always "job".

Allowed value: "job"
cast_usage
Cast Usage · object | null

Jobs created with X-Voyager-Cast-Version: 1 and input.cast: what the Elements compiled to (strategy, card versions, sent and omitted photos, warnings). Absent on every other job.