Sign in
Video Captions

Add Captions to a Video

Create a captioned video from either an uploaded video file or an existing video ID.

You must provide exactly one of:

  • video: A video file upload (.mp4 or .mov), max 50mb
  • video_id: An existing video ID to add captions to

If providing video_id, the source video must have status COMPLETE before it can be captioned.

To fetch the captioned video, use the GET videos/{video_id} endpoint.

post/v1/videos/captions

Headers

x-api-keystring required

API Key for authentication

API Key for authentication

Response

Returns a Video object representing the captioning job

idstring required

Video generation job ID

object'video'
status'PROCESSING' | 'COMPLETE' | 'FAILED' | 'CANCELLED' required

Current state of the video

created_atinteger required

When the video was created (unix timestamp)

completed_atinteger nullable

When processing completed (unix timestamp)

progressinteger nullable

Progress percentage (0-100)

model'mirage-avatar-x' | 'mirage-video-1-latest' nullable

Model used for generation (only for source='generation')

generation_mode'image_to_video' | 'video_to_video' nullable

Generation mode resolved from the submitted inputs

aspect_ratio'9:16' | '16:9' nullable

Output aspect ratio resolved from the visual reference

source_video_idstring nullable

The input video that was captioned (only for source='caption')

caption_template_idstring nullable

Caption style template used (only for source='caption')

share_link_urlstring nullable

Public share link for a completed internal video, when enabled.

video_idstring required

[Deprecated] Use "id" instead.

Example response

{
  "completed_at": 1730822520,
  "created_at": 1730822400,
  "model": "mirage-avatar-x",
  "progress": 100,
  "status": "COMPLETE",
  "video_id": "video_abc123def456"
}

Changes

Changed in 2 of the 14 revisions of this API.122

  • fd2d6a77680e12See the full diff
    • ▲

      the response property const value mirage-video-1-latest was removed for the status

      response-property-const-removed

    • ●

      added the new mirage-avatar-x enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new mirage-video-1-latest enum value to the / response property for the response status

      response-property-enum-value-added

  • 11e1197415cb2See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added