Skip to main content
GET
/
v1
/
videos
/
captions
/
templates
/
{template_id}
Retrieve Caption Template
curl --request GET \
  --url https://api.mirage.app/v1/videos/captions/templates/{template_id} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "created_at": 123,
  "object": "caption_template",
  "preview_url": "https://captions-cdn.xyz/studio-assets/captions-style-previews/1FA3A381-5DDF-4ECD-936B-63D7CF16DEB0.mp4"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication.

Path Parameters

​
template_id
string
required

Response

200 - application/json

Returns a caption template

Represents a caption style template

​
id
string
required

Unique template identifier

Example:

"ctpl_123456789abcdefg"

​
name
string
required

Human-readable template name

Example:

"Bold White"

​
created_at
integer
required

When the template was created (unix timestamp)

Example:

1730000000

​
object
string
default:caption_template
Allowed value: "caption_template"
​
preview_url
string | null

URL to a preview video of the template

Example:

"https://captions-cdn.xyz/studio-assets/captions-style-previews/1FA3A381-5DDF-4ECD-936B-63D7CF16DEB0.mp4"