Captions

App · 7 actions

Generate avatar videos, add styled captions and check video processing in Mirage.

Actions

ActionWhat it does
Add captions to videoCreate a captioned video from either an uploaded video file or an existing video ID.
Generate avatar videoGenerate avatar video.
Get caption templateGet caption template.
Get video download linkDownload the video file (redirects to video URL).
Get video statusGet the status of a video.
List caption templatesList available caption style templates.
List videosList videos for the authenticated API key with optional pagination.

Add captions to video

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

Inputs

Caption templatecaption_template_idtextRequired
Caption style template ID
Videovideotext
Video file to caption (MP4, MOV). Must be 9:16 aspect ratio. Max 50mb. Either video or video_id must be provided.
Videovideo_idtext
Existing video ID to add captions to. Either video or video_id must be provided.

Outputs

dataobject
Represents a video object.
Example output
{
  "data": {
    "aspect_ratio": "example",
    "caption_template_id": "example",
    "completed_at": 1,
    "created_at": 1,
    "error": {
      "code": "example",
      "message": "example"
    },
    "generation_mode": "example",
    "id": "example",
    "model": "example",
    "object": "example",
    "progress": 1,
    "source_video_id": "example",
    "status": "example",
    "video_id": "example"
  }
}

Generate avatar video

Generate avatar video.

Inputs

Audio referenceaudio_referencetextRequired
Driving audio file (WAV or MP3, 1-180 seconds)
Video referencevideo_referencetext
Video appearance reference (MP4 or MOV, 10-60 seconds; feature-gated preview). Exactly one visual reference is required.
Modelmodeltext
Model to use for generationOne of: mirage-avatar-x, mirage-video-1-latest. Default: mirage-avatar-x.
Image referenceimage_referencetext
Image appearance reference (JPEG or PNG). Exactly one visual reference is required.

Outputs

dataobject
Represents a video object.
Example output
{
  "data": {
    "aspect_ratio": "example",
    "caption_template_id": "example",
    "completed_at": 1,
    "created_at": 1,
    "error": {
      "code": "example",
      "message": "example"
    },
    "generation_mode": "example",
    "id": "example",
    "model": "example",
    "object": "example",
    "progress": 1,
    "source_video_id": "example",
    "status": "example",
    "video_id": "example"
  }
}

Get caption template

Get caption template.

Inputs

Templatetemplate_idtextRequired
Template Id

Outputs

dataobject
Represents a caption style template
Example output
{
  "data": {
    "created_at": 1,
    "id": "example",
    "name": "example",
    "object": "example",
    "preview_url": "example"
  }
}

Download the video file (redirects to video URL).

Inputs

Videovideo_idtextRequired
Video Id

Outputs

dataobject
Result.
Example output
{
  "data": {
    "url": "example"
  }
}

Get video status

Get the status of a video.

Inputs

Videovideo_idtextRequired
Video Id

Outputs

dataobject
Represents a video object.
Example output
{
  "data": {
    "aspect_ratio": "example",
    "caption_template_id": "example",
    "completed_at": 1,
    "created_at": 1,
    "error": {
      "code": "example",
      "message": "example"
    },
    "generation_mode": "example",
    "id": "example",
    "model": "example",
    "object": "example",
    "progress": 1,
    "source_video_id": "example",
    "status": "example",
    "video_id": "example"
  }
}

List caption templates

List available caption style templates.

Inputs

Limitlimitnumber
Max number of items to returnFrom 1 to 100. Default: 20.
Afteraftertext
Return items strictly after this template ID

Outputs

dataobject
Paginated list of caption templates
Example output
{
  "data": {
    "data": [],
    "has_more": false,
    "object": "example"
  }
}

List videos

List videos for the authenticated API key with optional pagination.

Inputs

Afteraftertext
Return items strictly after this video ID
Limitlimitnumber
Max number of items to returnFrom 1 to 100. Default: 20.
Orderordertext
Sort order by creation timeOne of: asc, desc. Default: desc.

Outputs

datalist
Response List Videos V1 Videos Get
Example output
{
  "data": []
}

On this page