Create a job
curl --request POST \
--url https://api.voyager.so/v1/jobs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"model": "<string>"
}
'import requests
url = "https://api.voyager.so/v1/jobs"
payload = { "model": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({model: '<string>'})
};
fetch('https://api.voyager.so/v1/jobs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "<string>",
"type": "<string>",
"model": "<string>",
"operation": "<string>",
"status": "queued",
"input": {},
"outputs": [
{
"id": "<string>",
"type": "<string>",
"mime_type": "<string>",
"file_name": "<string>",
"size_bytes": 123,
"url": "<string>",
"url_expires_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"object": "file",
"width": 123,
"height": 123,
"duration_seconds": 123,
"formats": [
{
"format": "<string>",
"id": "<string>",
"url": "<string>",
"url_expires_at": "2023-11-07T05:31:56Z"
}
],
"preview_url": "<string>",
"role": "<string>",
"metadata": {}
}
],
"credits": {
"estimated": 123,
"held": 123,
"charged": 123,
"released": 123,
"state": "pending",
"charge_ref": "<string>"
},
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"poll_after_ms": 123,
"links": {
"self": "<string>",
"cancel": "<string>"
},
"object": "job",
"cast_usage": {}
}{
"id": "<string>",
"type": "<string>",
"model": "<string>",
"operation": "<string>",
"status": "queued",
"input": {},
"outputs": [
{
"id": "<string>",
"type": "<string>",
"mime_type": "<string>",
"file_name": "<string>",
"size_bytes": 123,
"url": "<string>",
"url_expires_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"object": "file",
"width": 123,
"height": 123,
"duration_seconds": 123,
"formats": [
{
"format": "<string>",
"id": "<string>",
"url": "<string>",
"url_expires_at": "2023-11-07T05:31:56Z"
}
],
"preview_url": "<string>",
"role": "<string>",
"metadata": {}
}
],
"credits": {
"estimated": 123,
"held": 123,
"charged": 123,
"released": 123,
"state": "pending",
"charge_ref": "<string>"
},
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"poll_after_ms": 123,
"links": {
"self": "<string>",
"cancel": "<string>"
},
"object": "job",
"cast_usage": {}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}Create a job
Start a generation. 201 with the queued job, or 200 with the finished job when it ends within
Prefer: wait=N (Preference-Applied echoes it).
POST
/
jobs
Create a job
curl --request POST \
--url https://api.voyager.so/v1/jobs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"model": "<string>"
}
'import requests
url = "https://api.voyager.so/v1/jobs"
payload = { "model": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({model: '<string>'})
};
fetch('https://api.voyager.so/v1/jobs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "<string>",
"type": "<string>",
"model": "<string>",
"operation": "<string>",
"status": "queued",
"input": {},
"outputs": [
{
"id": "<string>",
"type": "<string>",
"mime_type": "<string>",
"file_name": "<string>",
"size_bytes": 123,
"url": "<string>",
"url_expires_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"object": "file",
"width": 123,
"height": 123,
"duration_seconds": 123,
"formats": [
{
"format": "<string>",
"id": "<string>",
"url": "<string>",
"url_expires_at": "2023-11-07T05:31:56Z"
}
],
"preview_url": "<string>",
"role": "<string>",
"metadata": {}
}
],
"credits": {
"estimated": 123,
"held": 123,
"charged": 123,
"released": 123,
"state": "pending",
"charge_ref": "<string>"
},
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"poll_after_ms": 123,
"links": {
"self": "<string>",
"cancel": "<string>"
},
"object": "job",
"cast_usage": {}
}{
"id": "<string>",
"type": "<string>",
"model": "<string>",
"operation": "<string>",
"status": "queued",
"input": {},
"outputs": [
{
"id": "<string>",
"type": "<string>",
"mime_type": "<string>",
"file_name": "<string>",
"size_bytes": 123,
"url": "<string>",
"url_expires_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"object": "file",
"width": 123,
"height": 123,
"duration_seconds": 123,
"formats": [
{
"format": "<string>",
"id": "<string>",
"url": "<string>",
"url_expires_at": "2023-11-07T05:31:56Z"
}
],
"preview_url": "<string>",
"role": "<string>",
"metadata": {}
}
],
"credits": {
"estimated": 123,
"held": 123,
"charged": 123,
"released": 123,
"state": "pending",
"charge_ref": "<string>"
},
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"poll_after_ms": 123,
"links": {
"self": "<string>",
"cancel": "<string>"
},
"object": "job",
"cast_usage": {}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}Authorizations
A Voyager API key from https://voyager.so/dashboard/api.
Headers
A new UUID per logical request; resend it on retries. Same key + same body returns the original job at any age; a different body is 409.
wait=N (≤ 60): return the finished job if it ends.
1: input.cast takes saved cards with selections and inline packages, input.cast_policy and input.cast_plan, and answers carry cast_usage. Omit for today's string Cast.
Body
application/json
A model id from GET /v1/models.
Required string length:
1 - 200One of text-to-image, edit, text-to-video, image-to-video, reference-to-video, tts, music, sound-effects, text-to-3d, image-to-3d, image-to-3d-body, align-3d, segment-image, segment-image-data, segment-video, segment-video-data, segment-everything, image-embedding (GET /v1/models/{id} lists a model's). Required unless the model runs only one.
Available options:
text-to-image, edit, text-to-video, image-to-video, reference-to-video, tts, music, sound-effects, text-to-3d, image-to-3d, image-to-3d-body, align-3d, segment-image, segment-image-data, segment-video, segment-video-data, segment-everything, image-embedding The model's canonical inputs: its input_schema on GET /v1/models/{id} (file_ ids or https URLs for media), plus optional cast (up to 4 cst_ ids) on image and video operations.
Show child attributes
Show child attributes
Public https URL that receives job.succeeded / job.failed / job.canceled (Standard Webhooks).
Maximum string length:
2048Up to 16 string pairs echoed on the job and its webhooks (values ≤ 500 chars).
Show child attributes
Show child attributes
Response
Finished within Prefer: wait, or an idempotent replay.
job_…
image, video, speech, music, sound_effect or 3d.
The model that ran (or will run) the job.
e.g. text-to-image, edit, image-to-video, tts.
queued, running, succeeded, failed or canceled.
Available options:
queued, running, succeeded, failed, canceled The job's input, as sent.
The files the job made, once it succeeded.
Show child attributes
Show child attributes
What the job is expected to cost and what it was charged.
Show child attributes
Show child attributes
Why the job failed or was canceled.
Show child attributes
Show child attributes
The metadata sent with the job, echoed as is.
Show child attributes
Show child attributes
When it was created (ISO 8601).
When the job started running (ISO 8601); null while queued.
When the job reached a terminal status (ISO 8601); null until then.
While active: when to poll again.
Links to read and cancel the job.
Show child attributes
Show child attributes
Always "job".
Allowed value:
"job"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.