Retrieve a video | Sample

1 parameter

video_idstringrequired

The identifier of the video to retrieve.

1 status code

200Returns the video job with its identifier, model, lifecycle `status`, progress, creation and completion timestamps, expiration timestamp, prompt, resolution, duration, source video reference, and any error details.

idstringrequired

Unique identifier for the video job.

objectstringrequired

The object type, which is always `video`.

Allowed:videoDefault:video

modelstringrequired

The video generation model that produced the job.

statusstringrequired

Current lifecycle status of the video job.

Allowed:queuedin_progresscompletedfailed

progressintegerrequired

Approximate completion percentage for the generation task.

created_atintegerrequired

Unix timestamp (seconds) for when the job was created.

completed_atintegerrequired

Unix timestamp (seconds) for when the job completed, if finished.

expires_atintegerrequired

Unix timestamp (seconds) for when the downloadable assets expire, if set.

promptstringrequired

The prompt that was used to generate the video.

sizestringrequired

The resolution of the generated video.

Allowed:720x12801280x7201024x17921792x1024

secondsstringrequired

Duration of the generated clip in seconds. For extensions, this is the stitched total duration.

remixed_from_video_idstringrequired

Identifier of the source video if this video is a remix.

errorobjectrequired

Error payload that explains why generation failed, if applicable.

Error handling

video_id must identify the generated video whose metadata you want to retrieve. Provide the identifier as a string.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.videos.get({ videoId: "c0a80123-4567-89ab-cdef-0123456789ab" });

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "object": "video",
  "model": "example_value",
  "status": "queued",
  "progress": 1,
  "created_at": 1,
  "completed_at": 1,
  "expires_at": 1,
  "prompt": "example_value",
  "size": "720x1280",
  "seconds": "example_value",
  "remixed_from_video_id": "550e8400-e29b-41d4-a716-446655440000",
  "error": {
    "code": "123456",
    "message": "This is an example message.",
    "misalignment": {
      "error_type": "example_value",
      "detailed_explanation": "example_value",
      "steer": {
        "message": "This is an example message."
      }
    }
  }
}

Request

Response

Errors