New: AI video tools. Cut, clip, caption and dub your videos. See all video tools →
Jobs

Get a job

GET
/v1/jobs/{id}

Returns a job. With wait, holds the request until the job finishes or wait seconds pass.

Authorization

bearer
headerAuthorizationBearer <API key>

An API key from Settings, starting vcp_live_.

Path Parameters

id*string

Query Parameters

wait?number

Seconds to wait for the job to finish, up to 60.

Range0 <= value <= 60

Response Body

OK.

application/json
  1. response
id*string

Job id.

type*JobType
Value in"speech""voice_design""voice_clone""voice_change""transcription""dub""avatar_video""cut"
status*JobStatus
Value in"queued""running""succeeded""failed""cancelled"
progress*|

From 0 to 1 while an avatar video renders, a dub runs or a video is cut, otherwise null.

Range0 <= value <= 1
result*||||||

The result of a succeeded job, or null. Speech, voice designs and the voice changer give AudioResult, kept for 24 hours after the job finishes, then this is null. Transcriptions give TranscriptionResult. Voice clones give VoiceCloneResult. Avatar videos give AvatarVideoResult, dubs give DubResult and cuts give CutResult, all kept for 24 hours after the job was created.

error*|

Why the job failed, or null.

tokens_charged*|

Tokens billed, or null until billing has run.

Range0 <= value
resource_id*|

The voice id for voice clones, the project id for dubs and cuts, and the video id for avatar videos.

created_at*string

When the job was created.

Formatdate-time
finished_at*|

When the job finished, or null while it runs.

Formatdate-time
Example Request
curl -X GET 'https://api.vcp.name/v1/jobs/string'
Example Response
{  "id": "04bd0571-e2c8-4d5b-a3cc-e56f85773abf",  "type": "speech",  "status": "succeeded",  "progress": null,  "result": {    "audio_url": "https://files.example.com/speech.wav",    "download_url": "https://files.example.com/speech.wav?download=speech.wav",    "expires_at": "2026-10-31T00:10:42Z"  },  "error": null,  "tokens_charged": 42,  "resource_id": null,  "created_at": "2026-10-30T00:10:42Z",  "finished_at": "2026-10-30T00:18:01Z"}