{ "openapi": "3.0.1", "info": { "title": "Video Caption Overlay Actor", "description": "Captions Generator - TikTok, Youtube, Instagram, Shorts, Final Cut Pro, davinci resolve, Premiere Pro, CapCut, elevenlabs.\nSimply input your existing Sound source: mp4, MOV, mp3, webm + others and customize the caption color & settings and generate. Output can be original clip or transparent overlay", "version": "1.0", "x-build-id": "vQ4Pg1TFM9kis5WxI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/eggvelop_official~caption-overlay-actor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-eggvelop_official-caption-overlay-actor", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/eggvelop_official~caption-overlay-actor/runs": { "post": { "operationId": "runs-sync-eggvelop_official-caption-overlay-actor", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/eggvelop_official~caption-overlay-actor/run-sync": { "post": { "operationId": "run-sync-eggvelop_official-caption-overlay-actor", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "inputUrl" ], "properties": { "inputUrl": { "title": "Input Media File", "type": "string", "description": "Upload a file or provide a URL to audio/video (mp3, wav, m4a, flac, mp4, webm, mov, mkv). Uses Whisper medium model for accurate transcription." }, "inputType": { "title": "Input Type", "enum": [ "audio", "video" ], "type": "string", "description": "Type of input media", "default": "video" }, "outputType": { "title": "Output Type", "enum": [ "transparentOverlay", "captionedVideo" ], "type": "string", "description": "Generate a transparent overlay (captions only with TRANSPARENT background + audio) or burn captions onto the input video. Note: Transparent overlay requires WebM or MOV format.", "default": "transparentOverlay" }, "outputFormat": { "title": "Output Format", "enum": [ "mp4", "webm", "mov" ], "type": "string", "description": "Video format for output. For TRANSPARENT overlays, use WebM or MOV. For burned captions, MP4 works fine. Note: MP4 does NOT support transparency.", "default": "mp4" }, "resolution": { "title": "Resolution", "type": "object", "description": "Video resolution (width x height). Common: 1080x1920 (vertical), 1920x1080 (horizontal), 1080x1080 (square)", "properties": { "width": { "title": "Width", "type": "integer", "description": "Video width in pixels (320-3840)", "minimum": 320, "maximum": 3840 }, "height": { "title": "Height", "type": "integer", "description": "Video height in pixels (320-3840)", "minimum": 320, "maximum": 3840 } } }, "whisperLanguage": { "title": "Transcription Language", "enum": [ "auto", "en", "es", "fr", "de", "it", "pt", "ru", "zh", "ja", "ko", "ar", "hi" ], "type": "string", "description": "Language code for transcription (auto for automatic detection, or: en, es, fr, de, it, pt, ru, zh, ja, ko, ar, hi, etc.)", "default": "auto" }, "useAIEnhancement": { "title": "AI Caption Enhancement", "type": "boolean", "description": "Use Claude AI to intelligently group and enhance captions for better readability (recommended). Requires ANTHROPIC_API_KEY environment variable.", "default": true }, "customCaptions": { "title": "Custom Caption Text (Optional)", "maxLength": 10000, "type": "string", "description": "Provide your own caption text instead of auto-transcription. The AI will align this text with the audio timing while preserving word emphasis and capitalization." }, "saveSubtitleImages": { "title": "Save Subtitle Images", "type": "boolean", "description": "Save all subtitle PNG images as a zip archive (useful for debugging or custom implementations)", "default": false }, "styling": { "title": "Caption Styling", "type": "object", "description": "Customize caption appearance", "properties": { "fontFamily": { "title": "Font Family", "type": "string", "description": "Font family (Arial, Helvetica, 'Poppins', etc.)" }, "fontSize": { "title": "Font Size", "type": "integer", "description": "Font size in pixels", "minimum": 20, "maximum": 200 }, "fontWeight": { "title": "Font Weight", "type": "string", "description": "Font weight (normal, bold, 900, etc.)" }, "textColor": { "title": "Text Color", "type": "string", "description": "Text color (hex format)", "pattern": "^#[0-9A-Fa-f]{6}$" }, "highlightColor": { "title": "Highlight Color", "type": "string", "description": "Highlight color for current word (hex format)", "pattern": "^#[0-9A-Fa-f]{6}$" }, "strokeColor": { "title": "Stroke Color", "type": "string", "description": "Text stroke/outline color (hex format)", "pattern": "^#[0-9A-Fa-f]{6}$" }, "strokeWidth": { "title": "Stroke Width", "type": "integer", "description": "Text stroke width in pixels", "minimum": 0, "maximum": 20 }, "yPosition": { "title": "Y Position", "type": "integer", "description": "Vertical position (0-100, percentage from top)", "minimum": 0, "maximum": 100 }, "textAlign": { "title": "Text Alignment", "type": "string", "description": "Text alignment", "enum": [ "left", "center", "right" ] }, "maxWidth": { "title": "Max Width", "type": "integer", "description": "Maximum text width (0-100, percentage of video width)", "minimum": 20, "maximum": 100 }, "shadow": { "title": "Shadow", "type": "boolean", "description": "Add text shadow for better readability" } } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }