Videos

Video status and result (poll this)

Poll while status is queued/processing (respect poll_interval_seconds, typically 5s). Terminal states: completed (with video_url) and failed (credits auto-refunded). Free previews stay in preview until rendered after an upgrade.

get/v1/videos/{video_id}

Request

Base URL
https://api.vivideo.ai
Auth
HTTP bearer
TypeScript
https://skmtc.dev/vivideo/apis/vivideo-api/docs/v1/videos/:video_id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

video_idstring required

Response

Current state of the video.

idstring

objectstring

mode'auto' | 'manual'

modelstring

status'queued' | 'processing' | 'completed' | 'failed' | 'preview'

namestring

folder_idstring

created_atstring

credits_chargednumber

poll_interval_secondsinteger

video_urlstring

Present when status=completed.

video_url_no_captionsstring

caption_urlstring

thumbnail_urlstring

duration_secondsnumber

Example response

{
  "object": "video",
  "model": "veo31_fast",
  "poll_interval_seconds": 5,
  "error": {
    "code": "generation_failed"
  },
  "preview": {
    "upgrade_url": "https://app.vivideo.ai/upgrade"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.