Ondertitels aan een video toevoegen

POST https://api.voicecheap.ai/v1/actions/subtitles_burn

​

Authenticatie en machtigingen

​

Parameters

{
  "type": "object",
  "properties": {
    "fileKey": {
      "type": "string",
      "minLength": 1,
      "maxLength": 1024,
      "description": "An owned fileKey returned by a completed upload or media import. Each generation consumes its uploaded source."
    },
    "fileName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "pattern": "^[^/\\\\\\r\\n\\0]+$"
    },
    "keyterms": {
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 120
      }
    },
    "requestId": {
      "description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries.",
      "type": "string",
      "format": "uuid",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "subtitleLayout": {
      "type": "object",
      "properties": {
        "maxLinesPerCaption": {
          "anyOf": [
            {
              "type": "number",
              "const": 1
            },
            {
              "type": "number",
              "const": 2
            },
            {
              "type": "number",
              "const": 3
            }
          ]
        },
        "maxCharactersPerLine": {
          "type": "integer",
          "minimum": 24,
          "maximum": 64
        }
      },
      "required": ["maxLinesPerCaption", "maxCharactersPerLine"],
      "additionalProperties": false
    },
    "srtContent": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2097152
    },
    "detectedLanguage": {
      "type": "string",
      "minLength": 2,
      "maxLength": 60
    },
    "subtitleStyle": {
      "type": "object",
      "properties": {
        "fontFamily": {
          "type": "string",
          "enum": ["sans", "serif", "mono"]
        },
        "fontSize": {
          "type": "string",
          "enum": ["small", "medium", "large"]
        },
        "textColor": {
          "type": "string",
          "enum": ["white", "yellow", "cyan"]
        },
        "backgroundStyle": {
          "type": "string",
          "enum": ["outline", "box", "shadow"]
        },
        "position": {
          "type": "string",
          "enum": ["bottom", "middle"]
        }
      },
      "required": ["fontFamily", "fontSize", "textColor", "backgroundStyle", "position"],
      "additionalProperties": false
    }
  },
  "required": ["fileKey"],
  "additionalProperties": false
}

​

Idempotentie

​

Voorbeeldaanvragen

curl --request POST 'https://api.voicecheap.ai/v1/actions/subtitles_burn' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"fileKey":"uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4","fileName":"interview.mp4","srtContent":"1\n00:00:00,000 --> 00:00:01,500\nHello world.\n","detectedLanguage":"english","subtitleLayout":{"maxLinesPerCaption":2,"maxCharactersPerLine":42},"subtitleStyle":{"fontFamily":"sans","fontSize":"medium","textColor":"white","backgroundStyle":"outline","position":"bottom"},"requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'

const input = {
  fileKey: 'uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4',
  fileName: 'interview.mp4',
  srtContent: '1\n00:00:00,000 --> 00:00:01,500\nHello world.\n',
  detectedLanguage: 'english',
  subtitleLayout: {
    maxLinesPerCaption: 2,
    maxCharactersPerLine: 42,
  },
  subtitleStyle: {
    fontFamily: 'sans',
    fontSize: 'medium',
    textColor: 'white',
    backgroundStyle: 'outline',
    position: 'bottom',
  },
  requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/subtitles_burn', {
  method: 'POST',
  headers: {
    'x-api-key': process.env.VOICECHEAP_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);

import os
import requests

response = requests.post(
    "https://api.voicecheap.ai/v1/actions/subtitles_burn",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"fileKey": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4", "fileName": "interview.mp4", "srtContent": "1\n00:00:00,000 --> 00:00:01,500\nHello world.\n", "detectedLanguage": "english", "subtitleLayout": {"maxLinesPerCaption": 2, "maxCharactersPerLine": 42}, "subtitleStyle": {"fontFamily": "sans", "fontSize": "medium", "textColor": "white", "backgroundStyle": "outline", "position": "bottom"}, "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)

​

Antwoord

{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "status": "running",
    "pollAction": "action_request_get",
    "pollAfterSeconds": 5
  },
  "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}

{
  "data": {
    "resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b",
    "operation": "subtitles_burn",
    "createdAt": 1792152000000,
    "fileName": "voicecheap-subtitles_burn-b3caf96f-5f2a-4619-832c-a12c0d57f78b.json",
    "byteLength": 225,
    "contentType": "application/json; charset=utf-8",
    "status": "completed",
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "getAction": "subtitles_result_get",
    "downloadAction": "subtitles_result_download",
    "listAction": "subtitles_result_list"
  },
  "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}

{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "operation": "subtitles_burn",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "running",
    "pollAfterSeconds": 5
  },
  "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}

{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "operation": "subtitles_burn",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "completed",
    "resultStored": false,
    "message": "The action completed. Retrieve its output from the corresponding history or resource action."
  },
  "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}

​

Resultaatvelden

​

Deze aanvraag herstellen en controleren

curl --request POST 'https://api.voicecheap.ai/v1/actions/action_request_get' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"requestId":"13579bdf-2468-4ace-8bdf-0123456789ab","operation":"subtitles_burn"}'

{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "operation": "subtitles_burn",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b",
      "operation": "subtitles_burn",
      "createdAt": 1792152000000,
      "fileName": "voicecheap-subtitles_burn-b3caf96f-5f2a-4619-832c-a12c0d57f78b.json",
      "byteLength": 225,
      "contentType": "application/json; charset=utf-8",
      "status": "completed",
      "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
      "getAction": "subtitles_result_get",
      "downloadAction": "subtitles_result_download",
      "listAction": "subtitles_result_list"
    }
  }
}

​

Opmerkingen bij de bewerking

• Vereist een betaald abonnement en de actiemachtiging. Het persoonlijke toolabonnement van de uitvoerende gebruiker wordt bij uitvoering opnieuw gecontroleerd; opgeslagen tools en uploadreferenties behoren toe aan die gebruiker, ook wanneer het toegangsmiddel aan een team is gekoppeld.
• Een geslaagde actie verbruikt één gedeelde maandelijkse API/MCP-aanroep. Beginner staat 500, Starter 5,000 en Creator 25,000 aanroepen/maand toe; Pro, Scale en Enterprise hebben geen maandelijkse bovengrens. De limieten per minuut blijven gelden: respectievelijk 30, 60, 120, 180, 300 en 600. Tegoeden voor toolgeneraties staan hier los van.
• Gebruik een UUID v4 voor requestId of een identieke Idempotency-Key-header en behoud dezelfde actie, ID en argumenten bij nieuwe pogingen. Een herhaling uit de cache verbruikt geen extra maandelijkse aanroep.
• Dit is een asynchrone actie. Het eerste transportresultaat is een aanvraag met status running en pollAction; peil action_request_get met deze bewerking en de oorspronkelijke requestId. Het hier getoonde resultaat van de voltooide bewerking is een compacte referentie naar opgeslagen uitvoer, niet de gegenereerde body.
• De volledige uitvoer wordt onder geauthenticeerd eigenaarschap opgeslagen in versleutelde opslag, onafhankelijk van de begrensde cache voor actiepolling. Roep de geretourneerde getAction aan met resultId en includeContent: true voor gestructureerde JSON, of downloadAction met resultId voor JSON-tekst. listAction biedt een herstelmogelijkheid als alleen de oorspronkelijke aanvraag bekend is.
• De opgeslagen JSON is beperkt tot 32 MiB. Metadata onthult nooit de versleutelingssleutel voor de opslag of een transcriptiedownload-URL zonder authenticatie.
• Een geslaagde generatie verbruikt één eenheid persoonlijk tooltegoed. Bij een mislukte generatie wordt de toolreservering normaal vrijgegeven. Als het onzeker is of de uitvoer is opgeslagen, controleer dan dezelfde aanvraag en de geschiedenis van opgeslagen resultaten voordat je opnieuw genereert; de server behoudt de reservering om dubbel verbruik te voorkomen.
• Hogere abonnementen zonder maandelijkse integratiebovengrens hebben nog steeds de onderstaande dagelijkse tooltegoeden en medialimieten. Deze zelfstandige acties gebruiken hun tooltegoed in plaats van nasynchronisatieminuten of TTS-tekens.
• Gebruik fileKey uit een voltooide upload of import waarvan je eigenaar bent en beschouw deze als eenmalig te gebruiken. Zodra de mediaverwerking begint, verwijdert de opschoning de bron na succes of een verwerkingsfout. Een afwijzing bij validatie of op basis van limieten vóór de verwerking kan de bron intact laten. Gebruik de oorspronkelijke requestId opnieuw om de geaccepteerde generatie te herstellen voordat je een nieuwe start.
• De bron moet video bevatten, maximaal 300 MiB groot zijn en niet langer duren dan 2 uur. Geef bestaande SRT op in srtContent of laat deze weg om ondertitels te genereren uit een audiostream. Zonder opgegeven SRT moet de bron ook audio bevatten.
• subtitleStyle is een volledig object: fontFamily sans/serif/mono, fontSize small/medium/large, textColor white/yellow/cyan, backgroundStyle outline/box/shadow en position bottom/middle. subtitleLayout vereist beide ondersteunde lay-outvelden.
• Daglimiet per tool: Beginner 5, Starter 15, Creator 30, Pro 60, Scale 100 en Enterprise 100 geslaagde generaties. Deze wordt gedeeld met de bijbehorende webtool en hanteert het resetvenster voor toolgebruik van het account.
• subtitles_burn en subtitles_burn_youtube delen de toollimiet van add-subtitles. Renderen met aangeleverde ondertitels gebruikt nog steeds één generatie. Renderen maakt een afzonderlijke uitvoervideo en probeert een geschiedenisitem voor het inbranden van ondertitels op te slaan.
• De bewerking retourneert alleen de vier ondertitel-/uitvoervelden in de opgeslagen JSON. Gebruik subtitles_burn_history_list/get en subtitles_burn_download om de lees-URL van de video te vernieuwen.

​

Verbruik

​

Fouten

{
  "code": "INSUFFICIENT_SCOPE",
  "message": "This credential does not permit the requested action.",
  "status": 403,
  "details": {
    "requiredScopes": ["subtitles:write"]
  }
}