Leggi un risultato salvato delle azioni di trascrizione

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

​

Autenticazione e autorizzazioni

​

Parametri

{
  "type": "object",
  "properties": {
    "resultId": {
      "type": "string",
      "format": "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)$"
    },
    "includeContent": {
      "default": false,
      "type": "boolean"
    }
  },
  "required": ["resultId"],
  "additionalProperties": false
}

​

Esempi di richiesta

curl --request POST 'https://api.voicecheap.ai/v1/actions/transcription_result_get' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"resultId":"b3caf96f-5f2a-4619-832c-a12c0d57f78b","includeContent":true}'

const input = {
  resultId: 'b3caf96f-5f2a-4619-832c-a12c0d57f78b',
  includeContent: true,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/transcription_result_get', {
  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/transcription_result_get",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b", "includeContent": True},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)

​

Risposta

{
  "data": {
    "resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b",
    "operation": "transcription_create",
    "createdAt": 1792152000000,
    "fileName": "voicecheap-transcription_create-b3caf96f-5f2a-4619-832c-a12c0d57f78b.json",
    "byteLength": 116,
    "contentType": "application/json; charset=utf-8",
    "status": "completed",
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "getAction": "transcription_result_get",
    "downloadAction": "transcription_result_download",
    "listAction": "transcription_result_list",
    "result": {
      "transcript": {
        "raw": "Hello world.",
        "paragraphs": "Hello world.",
        "sentences": "Hello world.",
        "detectedLanguage": "en"
      }
    }
  }
}

​

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.
• Il valore predefinito di includeContent è false. true decrittografa e restituisce il JSON generato completo sotto result. Questo esempio mostra la forma che restituisce il contenuto.
• La struttura del risultato annidato segue l’operazione originale. Gli output di trascrizione contengono il testo della trascrizione, gli output dei sottotitoli possono contenere dati SRT o del video renderizzato e le didascalie contengono il testo delle parole, startMs/endMs, speakerId che può essere null e durationSeconds.

​

Utilizzo

​

Errori

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