API Reference
Text Overlay API
API reference for the text overlay endpoint.
The Text Overlay API allows you to programmatically add text to a video.
Endpoint
POST /api/render/text
Authorization
All API requests require an API key to be included in the Authorization
header.
Authorization: Bearer YOUR_API_KEY
Request Body
Field | Type | Description |
---|---|---|
videoUrl | string | The URL of the video to add text to. |
textOverlays | array | An array of text overlay objects. |
textStyle | object | An object containing the style of the text. |
textOverlays
Object
Field | Type | Description |
---|---|---|
text | string | The text to overlay on the video. |
position | object | An object with x and y coordinates. |
textStyle
Object
Field | Type | Description |
---|---|---|
fontFamily | string | The font family of the text. |
fontSize | number | The font size of the text. |
color | string | The color of the text in hexadecimal format. |
Example Request
{
"videoUrl": "https://example.com/video.mp4",
"textOverlays": [
{
"text": "Hello World",
"position": { "x": 50, "y": 100 }
}
],
"textStyle": {
"fontFamily": "Arial",
"fontSize": 48,
"color": "#FFFFFF"
}
}
Example Response
{
"success": true,
"renderId": "some-render-id"
}