Utwórz słowa napisów ze znacznikami czasu

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

​

Uwierzytelnianie i uprawnienia

​

Parametry

{
  "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}$"
    }
  },
  "required": ["fileKey"],
  "additionalProperties": false
}

​

Idempotencja

​

Przykłady żądań

curl --request POST 'https://api.voicecheap.ai/v1/actions/captions_transcribe' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"fileKey":"uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.wav","fileName":"interview.wav","keyterms":["VoiceCheap"],"requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'

const input = {
  fileKey: 'uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.wav',
  fileName: 'interview.wav',
  keyterms: ['VoiceCheap'],
  requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/captions_transcribe', {
  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/captions_transcribe",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"fileKey": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.wav", "fileName": "interview.wav", "keyterms": ["VoiceCheap"], "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)

​

Odpowiedź

{
  "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": "captions_transcribe",
    "createdAt": 1792152000000,
    "fileName": "voicecheap-captions_transcribe-b3caf96f-5f2a-4619-832c-a12c0d57f78b.json",
    "byteLength": 190,
    "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": "captions_transcribe",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "running",
    "pollAfterSeconds": 5
  },
  "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}

{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "operation": "captions_transcribe",
    "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"
}

​

Pola wyniku

​

Odzyskaj żądanie i sprawdź jego stan

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":"captions_transcribe"}'

{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "operation": "captions_transcribe",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b",
      "operation": "captions_transcribe",
      "createdAt": 1792152000000,
      "fileName": "voicecheap-captions_transcribe-b3caf96f-5f2a-4619-832c-a12c0d57f78b.json",
      "byteLength": 190,
      "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"
    }
  }
}

​

Uwagi do operacji

• Wymaga płatnej subskrypcji i uprawnienia do akcji. Osobisty plan narzędzi użytkownika wykonującego żądanie jest ponownie sprawdzany podczas wykonywania; zapisane narzędzia i referencje przesłanych plików należą do tego użytkownika, również gdy dane uwierzytelniające są powiązane z zespołem.
• Pomyślna akcja zużywa jedno wspólne miesięczne wywołanie API/MCP. Beginner pozwala na 500, Starter na 5,000, a Creator na 25,000 wywołań miesięcznie; Pro, Scale i Enterprise nie mają miesięcznego limitu. Nadal obowiązują limity na minutę: odpowiednio 30, 60, 120, 180, 300 i 600. Limity generowania narzędzi są odrębne.
• Użyj requestId w formacie UUID v4 lub identycznego nagłówka Idempotency-Key i przy ponawianiu zachowuj tę samą akcję, identyfikator i argumenty. Odtworzenie zapisanej odpowiedzi nie zużywa kolejnego miesięcznego wywołania.
• To akcja asynchroniczna. Początkowy wynik transportu to żądanie w stanie running z pollAction; sprawdzaj action_request_get z tą operacją i pierwotnym requestId. Pokazany tutaj wynik ukończonej operacji to zwięzłe odwołanie do zapisanego wyjścia, a nie wygenerowana treść.
• Pełny wynik jest zapisywany w zaszyfrowanym magazynie danych jako własność uwierzytelnionego użytkownika, niezależnie od ograniczonej pamięci podręcznej sprawdzania stanu akcji. Wywołaj zwrócone getAction z resultId i includeContent: true, aby pobrać ustrukturyzowany JSON, lub downloadAction z resultId, aby pobrać tekst JSON. listAction umożliwia odzyskanie wyniku, gdy znane jest tylko oryginalne żądanie.
• Zapisany JSON jest ograniczony do 32 MiB. Metadane nigdy nie ujawniają klucza szyfrowania przechowywanej treści ani niewymagającego uwierzytelnienia adresu URL do pobrania transkrypcji.
• Pomyślne generowanie rozlicza jedno użycie osobistego limitu narzędzia. Nieudane generowanie zwykle zwalnia rezerwację narzędzia. Jeśli zapisanie wyjścia jest niepewne, przed ponownym generowaniem sprawdź to samo żądanie i historię zapisanych wyników; serwer zachowuje rezerwację, aby zapobiec podwójnemu zużyciu limitu.
• Wyższe plany bez miesięcznego limitu integracji nadal podlegają poniższym dziennym limitom narzędzi i limitom multimediów. Te samodzielne akcje korzystają z limitu swojego narzędzia zamiast z minut dubbingu lub znaków TTS.
• Użyj fileKey z ukończonego, należącego do Ciebie przesyłania lub importu i traktuj go jako jednorazowy. Po rozpoczęciu przetwarzania multimediów mechanizm czyszczenia usuwa źródło po powodzeniu lub błędzie przetwarzania. Odrzucenie podczas walidacji lub z powodu limitu przed rozpoczęciem przetwarzania może pozostawić je bez zmian. Użyj ponownie pierwotnego requestId, aby odzyskać zaakceptowane generowanie przed rozpoczęciem kolejnego.
• Prześlij wyłącznie wyodrębnioną ścieżkę audio: WAV, MP3, M4A, AAC, OGG, Opus lub FLAC, maksymalnie 250 MiB. Plik zawierający strumień wideo zostanie odrzucony, nawet jeśli jego nazwa ma rozszerzenie audio.
• Beginner akceptuje do 30 minut; Starter, Creator, Pro, Scale i Enterprise akceptują do 60 minut, z dodatkową tolerancją kontenera wynoszącą 2 sekundy.
• Dzienny limit transkrypcji napisów: Beginner 10, Starter 15, Creator 30, Pro 60, Scale 100 i Enterprise 100; współdzielony z internetowym narzędziem do napisów.
• Przesunięcia czasowe słów są podawane w milisekundach; durationSeconds jest podawane w sekundach. Serwer zwraca słowa ze znacznikami czasu, a nie wyrenderowany film z animacją. Lokalna edycja i renderowanie napisów w przeglądarce nie są objęte tą akcją.
• Transkrypcja napisów nie ma odrębnej rodziny akcji historii internetowej. Użyj subtitles_result_list/get/download, aby odzyskać jej pełny wynik integracji.

​

Wykorzystanie

​

Błędy

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