Retrieve video generation job

Get video generation job status

get

Retrieves the status, progress, and details of a specific video generation job.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

videoGenerationJobIdstringRequired

The ID of the video generation job.

Responses

200

Video generation job status and details retrieved successfully. The return value also contains all of the video-generation-job itself, which is not detailed here.

application/json

statusstring · enumOptional

The current status of the video generation job.

Possible values:

videoIdstringOptional

The ID of the provisioned generated video

progressnumberOptional

The current progress of the video generation job.

maximumProgressnumberOptional

The maximum progress value of the video generation job.

400

Bad Request. Invalid videoGenerationJobId parameter.

401

Unauthorized. Authentication required.

404

Not Found. Video generation job not found.

500

Internal server error.

get

/video-generation-jobs/{videoGenerationJobId}

HTTPcURLJavaScriptPython

GET /api/v1/video-generation-jobs/{videoGenerationJobId} HTTP/1.1
Host: app.colossyan.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "in_queue",
  "videoId": "text",
  "progress": 1,
  "maximumProgress": 1
}