Videos

Retrieve a video

Changed on

Retrieve the Video object (status / progress). Always JSON — the rendered MP4 is downloaded from GET /v1/videos/{video_id}/content.

get/v1/videos/{video_id}

Request

  • Base URL
    https://api.boson.ai
  • URL
    https://api.boson.ai/v1/videos/{video_id}
  • Auth
    HTTP bearer

Path parameters

video_idstring required

The video ID returned by POST /v1/videos.

Response

The Video object.

idstring

Video ID, e.g. video_8a1f....

object'video'
modelstring
status'queued' | 'in_progress' | 'completed' | 'failed'

Job status.

progressinteger

Completion percentage (0–100).

sizestring

Output size (WxH), e.g. 640x640.

created_atinteger

Unix timestamp (seconds).

errorstring nullable

Error message when status is failed.

Example response

{
  "id": "video_8a1f2c3d4e5f6a7b8c9d0e1f"
}

Changes

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status