VidMage

VidMage is an AI video and image creation platform for creators. Turn your ideas and images into videos and fresh visuals.

Open the creator tools
Explore APIs
AI Video APIsAI Image APIsAI Audio APIsAI 3D APIsAI Face Swap APIsAI Effects APIs
Build with VidMage
QuickstartAPI keysVidMage MCPError reference
Your account
Developer consoleAbout VidMagePlans and creditsAPI billingContact support
© 2026 VidMage. All rights reserved.
Privacy PolicyTerms of ServiceReport Abuse
Skip to content
VidMage/Developers
Overview
APIs
All APIsAI Video APIsAI Image APIsAI Audio APIsAI 3D APIsAI Face Swap APIsAI Effects APIs
DocumentationVidMage MCPOpen console
Developers/AI Subtitle Generator API for Video Captions

AI Subtitle Generator API for Video Captions

Add automatic subtitle generation to your video workflow with a source video URL. Track the processing task and retrieve the subtitled video for playback or further use in your app.

Get API keyView API docs
Abstract illustration for AI Subtitle Generator API for Video Captions
PlaygroundAPIPricingGuideFAQs

AI Subtitle Generator API Playground

Use your existing API key and subscription. Submitting a generation uses credits; uploading and preparing a request does not start a generation.

API access is available to subscribers only. Your subscription credits are shared across the website and the API.

View plans

Parameter

1 Parameter

Source-video fileUrl returned by upload_files.

Request code

#!/usr/bin/env bash
set -euo pipefail
# Set this once per intended task; preserve it and the body for transport retries.
: "${VIDMAGE_IDEMPOTENCY_KEY:?Set a unique key for this task}"

SUBMIT_RESPONSE="$(curl --fail-with-body --silent --show-error -X POST "https://vidmage.ai/api/v1/subtitle-generator/submit" \
  -H "Authorization: Bearer ${VIDMAGE_API_KEY}" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "videoUrl": "https://vidmage.ai/assets/models/hailuo-ai-video-generator/skincare-ad.mp4"
}')"
TASK_ID="$(printf '%s' "$SUBMIT_RESPONSE" | jq -er '.["taskId"]')"

while true; do
  QUERY_RESPONSE="$(curl --fail-with-body --silent --show-error -X POST "https://vidmage.ai/api/v1/subtitle-generator/query" \
    -H "Authorization: Bearer ${VIDMAGE_API_KEY}" \
    -H "Content-Type: application/json" \
    --data-raw "{\"taskId\":\"${TASK_ID}\"}")"
  STATUS="$(printf '%s' "$QUERY_RESPONSE" | jq -r '(.status // .data.status // "") | ascii_downcase')"
  case "$STATUS" in
    success|succeeded|completed)
      RESULT="$(printf '%s' "$QUERY_RESPONSE" | jq -r '(.result // .["videoUrl"] // .data["videoUrl"] // empty)')"
      if [ -z "$RESULT" ]; then
        printf '%s' "Result missing; preserve task $TASK_ID and query the same task again. Do not resubmit." >&2
        exit 2
      fi
      printf '%s\n' "$RESULT"
      break
      ;;
    needs_input)
      printf '%s' "Face selection required; preserve task $TASK_ID" >&2
      exit 2
      ;;
    failed|error)
      printf '%s' "$QUERY_RESPONSE" | jq -r '(.message // .error // .data.error // "Task failed")' >&2
      exit 1
      ;;
  esac
  sleep 5
done

Response data

Submit the task to see the API response here.
PlaygroundCapabilities

API documentation

Submit a request, track the task, and retrieve your result.

Required inputs
videoUrl
Output
Video·videoUrl
Request setup & limitsHeaders, input options and media limits

Request headers

Authorization
Bearer YOUR_API_KEY

Keep your API key on your server.

Content-Type
application/json
Idempotency-Key
YOUR_UNIQUE_KEY

Use a new key per task. Reuse it only when retrying the same submission.

Input options & limits

Request controls follow each task's parameter rules; they do not guarantee output properties.

Subtitle Generator

RequiredvideoUrl

Output dimensions and format are not specified in this reference.

Input retention and output-link lifetime depend on the API contract. Confirm API-specific retention terms before making promises to your users. Upload guide ↗

Subtitle Generator

POST /api/v1/subtitle-generator/submit

Full API documentation ↗

videoUrl is required.

Required inputs

videoUrlstring
Source-video fileUrl returned by upload_files.

Edit the sample inputs for your own task before submitting.

Subtitle Generator request
# Set VIDMAGE_IDEMPOTENCY_KEY to a unique value for this task; preserve it for transport retries.
curl -X POST "https://vidmage.ai/api/v1/subtitle-generator/submit" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"videoUrl":"https://vidmage.ai/assets/models/hailuo-ai-video-generator/skincare-ad.mp4"}'
# -> { "success": true, "taskId": "...", "creditsConsumed": ... }
Parameters and input rules1 field
FieldTypeRequiredDefaultMeaning and limits
videoUrlstringYesNot specifiedSource-video fileUrl returned by upload_files. No additional field constraint listed.

Retrieve the result

Save taskId from the accepted submission and send it to this endpoint:

POST /api/v1/subtitle-generator/query

Use the same Bearer API key. On completion, read the videoUrl result field.

Task states and recovery ↗
Subtitle Generator query
curl -X POST "https://vidmage.ai/api/v1/subtitle-generator/query" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "taskId": "TASK_ID_FROM_SUBMIT" }'
# -> { "success": true, "data": { "status": "...", "videoUrl": "https://..." } }

Pricing

See what one image, video, or generation costs in credits. Your API and website activity share the same credit balance.

API credit rates and calculated example request costs
API / workflowExample requestPrice (credits)
Subtitle Generatorvideo API5.875-second video: 20 credits
How this is calculated
  • Video duration: 1 credit / second · 20 credits minimum

The example uses the duration shown above. The server measures uploaded media for billing; this duration is only supplied to the estimate.

Duration × rate is rounded up to whole credits; the applicable minimum charge is enforced.

Estimate your own request ↗
1 credit / second20 credits minimum
Billed in credits. Shared with the website.Active subscription required. Unit rates and examples follow current API credit rules.Billing details⌄

Examples show the charge for the inputs listed above. Resolution, duration, audio, output count and reference media can change the total. Minimum charges and rounding follow the selected API.

Use the Playground to estimate your request before submitting it. Estimates do not start a generation. Subscription and credit-pack prices are listed on the plans page.

Your task’s recorded usage is the source of truth for the final charge.

View plans ↗Billing guide ↗

About AI Subtitle Generator API

VidMage's AI Subtitle Generator API is a video processing interface that generates subtitles from speech in a source clip. It accepts a video URL and returns a subtitled video. The result supports captioning workflows in which editors review wording and timing before using the finished asset. To add subtitles to a clip in your browser, use VidMage's AI Subtitle Generator.

AI Subtitle Generator API capabilities

Speech-based subtitle generation
Use the speech in a source video as the basis for the requested subtitles in the processed clip.
Single video input
Submit a video URL without supplying a separate transcript, subtitle file, or manual caption text in the request.
Subtitled video result
Retrieve the returned video and review the generated captions in the context of the full visual sequence.

What you can build

Podcast highlight captions

Prepare a spoken podcast excerpt for viewers who watch with captions. The source video supplies the speech for subtitle generation; an editorial pass checks guest names, terminology, and timing before the highlight is published.

Subtitles for short drama clips

Finished dialogue scenes can become captioned episodes, trailers, or social teasers. Submit the scene and inspect the returned subtitled video, paying attention to character names and whether each line appears at the right moment.

Captioned tutorials

Technical terms and on-screen controls both matter in a tutorial. Add subtitle generation to the publishing flow for narrated clips, with a review step that checks the wording and whether captions cover the controls being demonstrated.

How to use AI Subtitle Generator API

  1. Get an API key

    Create a key in the Developer Console and store it on your server. Use it in the Authorization: Bearer header.

  2. Prepare and submit your inputs

    Set up your inputs in the Playground, then copy the matching API request. Send it from your server with a unique Idempotency-Key.

  3. Track the task

    Save the returned taskId and query the same operation until it completes. Keep that identifier if your app stops waiting.

  4. Retrieve the result

    Read videoUrl from the completed task. Preview the result in your app and save a copy to your own storage for later use.

Input tips
Plan around the video result
The documented output is videoUrl. SRT, VTT, transcript text, and word-level timestamps are not established, so confirm any editable-track requirement before designing export options.
Keep an editorial check
Review names, numbers, caption placement, and timing in the returned clip. The request has no language selector, font controls, or in-place subtitle editing field.

Input requirementsUpload local files

Task fields and results

Keep the task identifier with its original request and Idempotency-Key. Query the same capability until it completes, then read the documented result field.

Task identifier
taskId
Query route
POST /api/v1/subtitle-generator/query
Completed result
videoUrl
Task states and response structure ↗
Errors, retries and limits

Retry transport failures with the same idempotency key only when the original submission may not have reached the server. For a confirmed task, keep querying the original task instead of submitting a duplicate.

Read error recovery guidance ↗

FAQs

Does this translate or dub the spoken audio?

No translation target or replacement-audio input is published. Subtitle generation does not establish a dubbing workflow. Review AI Lip Sync separately if you need speaking animation.

Are failed or timed-out requests charged?

A client timeout is not a confirmed task failure. Confirmed failures are automatically refunded only when the refund outcome is certain. Unknown charges or refunds remain pending reconciliation.

Failure and refund handling ↗
How long should my app wait for a result?

The checked contract does not establish a fixed completion time. Choose a local wait budget for your app; it is not an API completion deadline.

Polling and wait budgets ↗
What are the rate and concurrency limits?

Request-rate limits control how often you can call the API; concurrency limits control simultaneous work. The documentation ties both to the stable API key but does not publish numeric limits for this operation. Confirm account limits before planning parallel jobs.

Rate-limit recovery ↗
Can I receive results through a webhook?

The checked request contract documents status queries and does not list a webhook or callback field for these routes. Check the current authenticated OpenAPI contract before making a callback part of your integration.

Query task results ↗Check the current contract ↗

Explore more APIs on VidMage

  • AI Lip Sync API for Photos and Videos↗
  • AI Video Extender API for Clip Continuations↗
  • AI Video Background Remover API for Clips↗
  • AI Video Watermark Remover API for Two Inputs↗
  • AI Video to Video API for Style Transformations↗
  • AI Video Upscaler API for 2x and 4x Requests↗
  • Midjourney Video API↗
  • PixVerse API↗