Skip to main content
POST
Esporta il risultato completo di tua proprietà come testo JSON con nome file e tipo di contenuto. L’accesso resta autenticato; nessun URL multimediale pubblico espone la trascrizione.

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:read. È 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.Formato: “uuid”. Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$.
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.

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

Una prima esecuzione riuscita restituisce HTTP 200 con il risultato dell’operazione in data. Una ripetizione può invece restituire lo stato della richiesta salvata. L’esempio mostra una risposta supportata, non tutti i campi facoltativi. Metadati di output salvati con il JSON generato completo serializzato come stringa content per un’esportazione locale autenticata.

Campi del risultato

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.
  • resultId è un UUID proveniente da un riferimento di generazione completata o da result_list di questo dominio. È diverso dal requestId dell’azione e dall’historyId dello strumento web.
  • I risultati appartengono all’attore autenticato e al dominio di autorizzazione. Un risultato del dominio subtitles non può essere letto tramite le azioni transcription, né viceversa.
  • Il JSON completo salvato viene crittografato a riposo e conservato indipendentemente dalla cache limitata di interrogazione delle azioni. Il recupero richiede comunque l’autenticazione; non viene emesso alcun URL pubblico del JSON della trascrizione o dei sottotitoli.
  • Queste azioni recuperano output esistenti e non generano contenuti multimediali né usano una quota giornaliera. Ogni recupero riuscito usa comunque una chiamata di integrazione mensile.
  • I metadati con stato pending indicano che il salvataggio dell’output richiede un recupero. La lettura o il download del contenuto tenta di recuperare un oggetto crittografato già salvato; controllalo prima di avviare un’altra generazione.
  • Scrivi content in fileName usando UTF-8 oppure usa JSON.parse(content) per recuperare l’output strutturato. La risposta esterna non contiene una proprietà result né un URL di download multimediale.
  • byteLength descrive il JSON UTF-8 contenuto in content; contentType è application/json; charset=utf-8. Il download tenta anche il recupero dell’output crittografato in attesa.

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