Skip to main content
POST
Recupera o genera la trascrizione di un video YouTube con segmenti temporizzati, testo semplice e sottotitoli SRT. Salva la cronologia delle trascrizioni. Restituisce un riferimento compatto al risultato salvato; usa il relativo getAction o downloadAction per recuperare l’output completo.

Autenticazione e autorizzazioni

string
obbligatorio
Invia una chiave API VoiceCheap in questa intestazione. È supportato anche Authorization: Bearer con la stessa chiave API. I token di accesso OAuth sono accettati solo da MCP, non da questo endpoint REST.
Autorizzazioni richieste: transcription:write. È necessario un abbonamento a pagamento attivo. Le autorizzazioni non modificano i ruoli del team, la proprietà delle risorse, i crediti multimediali o i limiti del piano.

Parametri

string
obbligatorio
Valore testuale.Lunghezza massima: 2048. Formato: “uri”.
string
Facoltativo al livello di trasporto: se omesso, il server inserisce un identificatore prima della validazione. Fornisci un tuo UUID v4 stabile per recuperare in sicurezza una risposta persa.Formato: “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}$.
Il JSON Schema seguente conserva i nomi esatti dei campi, i tipi annidati, i valori predefiniti, i limiti e i valori accettati esposti dalla discovery. Le ulteriori regole tra campi sono elencate nelle note sull’operazione.

Idempotenza

Usa un UUID v4 in requestId o nell’intestazione HTTP Idempotency-Key per ogni modifica. Riutilizza lo stesso identificatore e argomenti identici dopo un errore di rete. Se vengono forniti entrambi, devono coincidere. Ripetere una richiesta salvata non ripete l’operazione e non consuma un’altra chiamata mensile. Le richieste non riuscite o interrotte non vengono riavviate automaticamente. Ogni modifica può restituire HTTP 202 quando un nuovo tentativo trova la stessa richiesta ancora in esecuzione, anche se la prima esecuzione è normalmente sincrona. Se l’esecuzione è completata ma resultStored è false, un nuovo tentativo restituisce HTTP 200 con lo stato della richiesta salvata anziché il risultato originale. Recupera l’output tramite l’azione di cronologia, risultato o download del relativo dominio.

Esempi di richiesta

Sostituisci gli identificatori delle risorse e le chiavi multimediali di esempio con i valori restituiti per il tuo account. Mantieni stabile l’identificatore della richiesta quando ripeti la stessa modifica.

Risposta

Questa operazione restituisce HTTP 202 mentre è in esecuzione. Salva requestId e interroga action_request_get con questo identificatore e il nome dell’operazione originale. Gli stati del polling sono running, completed, failed e interrupted. Un risultato completato può rimandare a un processo multimediale separato; prosegui con l’azione di stato o di output specifica dell’operazione. Un riferimento a una trascrizione YouTube salvata. Il JSON completo contiene metadati del video, segmenti con riferimenti temporali, text, srt, createdAt e il campo opzionale language; per i sottotitoli nativi di YouTube può essere conservata un’etichetta della sorgente.

Campi del risultato

Recupera e monitora questa richiesta

Usa lo stesso identificatore anche dopo una connessione persa. Se resultStored è false, recupera l’output tramite la corrispondente azione di cronologia, risultato o download. Non avviare mai una seconda generazione solo per verificarne l’avanzamento.
HTTP 200

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 un URL HTTPS pubblico di YouTube su youtube.com, www.youtube.com, m.youtube.com, music.youtube.com o youtu.be, senza credenziali incorporate né una porta esplicita. Il video deve avere una durata massima di 2 ore.
  • Quota giornaliera per strumento: Beginner 5, Starter 15, Creator 30, Pro 60, Scale 100 ed Enterprise 100 generazioni riuscite. È condivisa con lo strumento web corrispondente e usa la finestra di azzeramento dello strumento dell’account.
  • Su ogni piano si applica un limite aggiuntivo di 12 tentativi di trascrizione YouTube al giorno, inclusi i tentativi falliti. Può essere inferiore alla quota di generazioni riuscite. Il percorso di integrazione usa il limite condiviso di integrazione al minuto.
  • Il JSON di integrazione salvato viene acquisito prima del successivo tentativo di salvataggio nella cronologia delle trascrizioni YouTube, il cui esito non è garantito. Pertanto transcriptId non fa parte di questo output completo archiviato; se necessario, trova la cronologia dello strumento web tramite youtube_transcript_history_list.
  • Non viene usata alcuna sorgente precaricata. L’output completo contiene startSeconds/endSeconds dei segmenti della trascrizione in secondi, mentre createdAt è in millisecondi.

Utilizzo

Ogni invocazione riuscita consuma una chiamata API/MCP mensile. Si applicano anche i crediti multimediali e le quote di generazione proprie dell’operazione.

Errori