Colossyan API
  • Welcome
  • Getting Started
    • Quickstart
    • Extracting request bodies from the web-editor
  • Basics
    • Authentication
    • Endpoints
    • Video Generation
      • Generating using a template
      • Generating a video manually
      • Receiving a generated video
    • Using template variables
      • Script template variables
      • Text template variables
    • Generated videos
      • Retrieve a video
      • Delete a video
    • Video generation job
      • Retrieve video generation job
      • Delete video generation job
    • Assets
      • Actors
      • Voices
  • Advanced
    • Advanced use-cases
    • Timing
  • Experimental
    • Knowledge to draft
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Basics
  2. Video generation job

Retrieve video generation job

PreviousVideo generation jobNextDelete video generation job

Last updated 1 month ago

Was this helpful?

Get video generation job status

get

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

Authorizations
Path parameters
videoIdstringRequired

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
400
Bad Request. Invalid videoId parameter.
401
Unauthorized. Authentication required.
404
Not Found. Video generation job not found.
500
Internal server error.
get
GET /api/v1/video-generation-jobs/{videoId} HTTP/1.1
Host: app.colossyan.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "status": "in_queue",
  "videoId": "text",
  "progress": 1,
  "maximumProgress": 1
}