Crea parole con indicazioni temporali per le didascalie

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

​

Autenticazione e autorizzazioni

​

Parametri

{
  "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
}

​

Idempotenza

​

Esempi di richiesta

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)

​

Risposta

{
  "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"
}

​

Campi del risultato

​

Recupera e monitora questa richiesta

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"
    }
  }
}

​

Note sull’operazione

• Richiede un abbonamento a pagamento e l’autorizzazione dell’azione. Il piano personale del chiamante per gli strumenti viene ricontrollato al momento dell’esecuzione; gli strumenti salvati e i riferimenti ai caricamenti appartengono a quel chiamante, anche quando la credenziale è associata a un team.
• Un’azione riuscita consuma una chiamata mensile condivisa API/MCP. Beginner consente 500, Starter 5,000 e Creator 25,000 chiamate al mese; Pro, Scale ed Enterprise non hanno un limite mensile. Si applicano comunque i limiti al minuto: rispettivamente 30, 60, 120, 180, 300 e 600. Le quote di generazione degli strumenti sono separate.
• Usa un requestId UUID v4, oppure un header Idempotency-Key identico, e mantieni la stessa azione, lo stesso ID e gli stessi argomenti nei tentativi successivi. La ripetizione di un risultato memorizzato nella cache non consuma un’altra chiamata mensile.
• Questa è un’azione asincrona. Il risultato iniziale del trasporto è una richiesta running con pollAction; interroga periodicamente action_request_get con questa operazione e il requestId originale. Il risultato dell’operazione completata mostrato qui è un riferimento compatto all’output salvato, non il corpo generato.
• L’output completo viene salvato in un archivio cifrato con titolarità autenticata, indipendentemente dalla cache limitata del polling delle azioni. Chiama il getAction restituito con resultId e includeContent: true per il JSON strutturato, oppure downloadAction con resultId per il testo JSON. listAction offre una via di recupero quando è nota solo la richiesta originale.
• Il JSON salvato è limitato a 32 MiB. I metadati non espongono mai la chiave di crittografia dell’archiviazione né un URL di download della trascrizione senza autenticazione.
• Una generazione riuscita consuma definitivamente un’unità della quota personale dello strumento. Una generazione non riuscita normalmente libera la relativa prenotazione. Quando la persistenza dell’output è incerta, controlla la stessa richiesta e la cronologia dei risultati salvati prima di generare di nuovo; il server mantiene la prenotazione per evitare consumi duplicati.
• Anche i piani superiori senza limite mensile per le integrazioni hanno le quote giornaliere specifiche degli strumenti e i limiti multimediali riportati di seguito. Queste azioni autonome utilizzano la quota del relativo strumento anziché i minuti di doppiaggio o i caratteri TTS.
• Usa fileKey di un caricamento o di un’importazione completati e di tua proprietà e consideralo monouso. Una volta iniziata l’elaborazione multimediale, la pulizia elimina il file di origine dopo il completamento o un errore di elaborazione. Un rifiuto dovuto alla validazione o alla quota prima dell’elaborazione può lasciarlo intatto. Riutilizza requestId originale per recuperare la generazione accettata prima di avviarne un’altra.
• Carica solo la traccia audio estratta: WAV, MP3, M4A, AAC, OGG, Opus o FLAC, fino a 250 MiB. Un file con un flusso video viene rifiutato anche se il nome del file ha un’estensione audio.
• Beginner accetta fino a 30 minuti; Starter, Creator, Pro, Scale ed Enterprise accettano fino a 60 minuti, più una tolleranza del contenitore di 2 secondi.
• Quota giornaliera di trascrizioni per sottotitoli: Beginner 10, Starter 15, Creator 30, Pro 60, Scale 100 ed Enterprise 100; condivisa con lo strumento web per i sottotitoli.
• Gli offset delle parole sono in millisecondi; durationSeconds è in secondi. Il server restituisce parole con riferimenti temporali, non un video animato renderizzato. La modifica e il rendering locali dei sottotitoli nel browser non rientrano in questa azione.
• La trascrizione dei sottotitoli non dispone di una famiglia separata di azioni per la cronologia web. Usa subtitles_result_list/get/download per recuperare il suo output completo dell’integrazione.

​

Utilizzo

​

Errori

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