> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Captions

> Captions provides the Mirage API for generating videos and speech and adding styled captions to videos.

![Captions logo](https://mintcdn.com/composio-preview/PudKL42NVsy5O-ND/images/toolkits/captions.svg?fit=max\&auto=format\&n=PudKL42NVsy5O-ND\&q=85\&s=ebebea8c06ec7ad1566d1acc99c96d04)

* **Category:** ai content generation
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 8
* **Triggers:** 0
* **Slug:** `CAPTIONS`
* **Version:** 00000000\_00

## Tools

> [accordion] Add Captions
>
> **Slug:** `CAPTIONS_ADD_CAPTIONS`
>
> Start an asynchronous job that transcribes and renders a selected caption style onto an uploaded or existing completed video. Use CAPTIONS\_GET\_VIDEO\_STATUS to monitor the returned job, then CAPTIONS\_DOWNLOAD\_VIDEO when it completes. This call consumes paid Mirage credits and cannot be cancelled or deleted once submitted.
>
> #### Input Parameters
>
> **video** `object`
>
> MP4 or MOV video upload. The video must use a 9:16 aspect ratio, be at most 50 MB, and be at most 5 minutes long. Provide this or video\_id, but not both.
>
> **video\_id** `string`
>
> ID of an existing COMPLETE video in video\_\* format. Provide this or video, but not both.
>
> **caption\_template\_id** `string` *required*
>
> Caption style template ID returned by CAPTIONS\_LIST\_CAPTION\_TEMPLATES.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Download Video
>
> **Slug:** `CAPTIONS_DOWNLOAD_VIDEO`
>
> Download the MP4 content of a completed video job and return an offloaded file reference. Use CAPTIONS\_GET\_VIDEO\_STATUS first to confirm the job is COMPLETE.
>
> #### Input Parameters
>
> **video\_id** `string` *required*
>
> ID of a completed video in video\_\* format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Speech
>
> **Slug:** `CAPTIONS_GENERATE_SPEECH`
>
> Generate WAV speech synchronously from text using a known Mirage voice ID and return an offloaded audio file reference. This call consumes paid Mirage credits and cannot be cancelled or deleted once submitted.
>
> #### Input Parameters
>
> **text** `string` *required*
>
> Text to synthesize as speech; must not be empty.
>
> **voice\_id** `string` *required*
>
> Mirage voice ID to synthesize with. The public API does not provide a voice-list endpoint.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Video
>
> **Slug:** `CAPTIONS_GENERATE_VIDEO`
>
> Start an asynchronous Mirage Video 1 job that animates a portrait image using speech audio. Use the returned job ID with CAPTIONS\_GET\_VIDEO\_STATUS. This call consumes paid Mirage credits and cannot be cancelled or deleted once submitted.
>
> #### Input Parameters
>
> **audio\_reference** `object` *required*
>
> WAV or MP3 speech audio that drives the portrait animation. Duration must be between 1 and 180 seconds.
>
> **image\_reference** `object` *required*
>
> JPEG or PNG portrait image to animate.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Caption Template
>
> **Slug:** `CAPTIONS_GET_CAPTION_TEMPLATE`
>
> Retrieve one caption style by ID, including its name and preview video URL.
>
> #### Input Parameters
>
> **template\_id** `string` *required*
>
> Caption template ID in ctpl\_\* format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Video Status
>
> **Slug:** `CAPTIONS_GET_VIDEO_STATUS`
>
> Retrieve the current state, progress, and error details for a video generation or captioning job.
>
> #### Input Parameters
>
> **video\_id** `string` *required*
>
> Video job ID in video\_\* format, returned by video generation or captioning.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Caption Templates
>
> **Slug:** `CAPTIONS_LIST_CAPTION_TEMPLATES`
>
> Return one page of available caption styles, including names and preview video URLs.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum caption templates to return on this page (1-100).
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Videos
>
> **Slug:** `CAPTIONS_LIST_VIDEOS`
>
> Return one page of video jobs owned by the connected Mirage account, including each job's status and progress.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum videos to return on this page (1-100).
>
> **order** `string ("asc" | "desc")`
>
> Sort videos by creation time in ascending or descending order.
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
