Video Captions

List Caption Templates

List available caption style templates.

Returns a paginated list of templates that can be used when creating captioned videos.

get/v1/videos/captions/templates

Request

Base URL
https://api.mirage.app (the document declares no server; this is the origin it was published from)
Auth
none declared. Required headers: x-api-key
TypeScript
https://skmtc.dev/mirage/apis/mirage-video-api/docs/v1/videos/captions/templates/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

limitinteger

Max number of items to return

afterstring nullable

Return items strictly after this template ID

Headers

x-api-keystring required

API Key for authentication

Response

Returns a paginated list of available caption templates

object'list'

has_moreboolean required

Whether there are more templates after this page

Example response

{
  "data": [
    {
      "id": "ctpl_123456789abcdefg",
      "name": "Bold White",
      "preview_url": "https://captions-cdn.xyz/studio-assets/captions-style-previews/1FA3A381-5DDF-4ECD-936B-63D7CF16DEB0.mp4",
      "created_at": 1730000000
    }
  ]
}

Changes

No recorded changes to this operation across all 15 revisions of this API.