Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Captions Meta Text Overlays API

Render static text overlays onto videos

Captions Meta Text Overlays API is one of 6 APIs that Captions publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Meta Text Overlays. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://api.captions.ai/api.

2 operations 2 paths 6 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.mirage.app
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Captions Meta Text Overlays API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Meta Text Overlays 2

Render static text overlays onto videos

POST
/v1/meta/text_overlays
Create Meta Text Overlay
createMetaTextOverlay 1 param body → 200422
GET
/v1/meta/text_overlays/{text_overlay_id}
Retrieve Meta Text Overlay
getMetaTextOverlay 2 params → 200422

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are MetaTextOverlay (7 properties), CreateMetaTextOverlayRequest (6 properties), MetaTextOverlayResult (5 properties), ValidationError (3 properties). Each schema is shown below with its type and property counts.

MetaTextOverlayResult
object
Per-text result for a Meta text overlay job.
5 properties 3 required
ValidationError
object
3 properties 3 required
MetaTextOverlay
object
Represents a Meta text overlay job.
7 properties 3 required
HTTPValidationError
object
1 property
CreateMetaTextOverlayRequest
object
Request body for creating a Meta text overlay job. Upload once and render up to 4 related text variants.
6 properties 1 required
MAVideoError
object
Error payload that explains why generation failed, if applicable
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

captions-ai-meta-text-overlays-api-openapi.yml Raw ↑

Other APIs Captions publishes across the network.

Captions AI Ads API
Captions AI Creator API
Captions Audio API
Captions Video Captions API
Captions Videos API