Leer un resultado guardado de una acción de transcripción

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

​

Autenticación y permisos

​

Parámetros

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

​

Ejemplos de solicitud

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)

​

Respuesta

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

​

Campos del resultado

​

Notas de la operación

• Requiere una suscripción de pago y el permiso de la acción. El plan personal de herramientas del actor se comprueba de nuevo al ejecutar; las herramientas guardadas y las referencias de carga pertenecen a ese actor, también cuando la credencial está asociada a un equipo.
• Una acción correcta consume una llamada mensual compartida de API/MCP. Beginner permite 500, Starter 5,000 y Creator 25,000 llamadas al mes; Pro, Scale y Enterprise no tienen límite mensual. Siguen aplicándose los límites por minuto: 30, 60, 120, 180, 300 y 600, respectivamente. Las cuotas de generación de las herramientas son independientes.
• resultId es un UUID de una referencia de generación completada o de result_list de este dominio. Es distinto del requestId de la acción y del historyId de la herramienta web.
• Los resultados pertenecen al actor autenticado y al dominio de permisos. Un resultado de subtitles no puede leerse mediante acciones de transcription, ni a la inversa.
• El JSON completo guardado se cifra en reposo y se conserva independientemente de la caché limitada de consulta de acciones. La recuperación sigue requiriendo autenticación; no se emite ninguna URL pública de JSON de transcripción o subtítulos.
• Estas acciones recuperan resultados existentes y no generan contenido multimedia ni utilizan una cuota diaria. Cada recuperación completada correctamente sigue utilizando una llamada de integración mensual.
• Los metadatos pendientes indican que es necesario recuperar la persistencia de la salida. Al leer el contenido o descargarlo, se intenta recuperar un objeto cifrado ya guardado; compruébalo antes de iniciar otra generación.
• El valor predeterminado de includeContent es false. true descifra y devuelve el JSON generado completo en result. Este ejemplo muestra la forma que devuelve el contenido.
• La estructura del resultado anidado sigue la de su operación original. Las salidas de transcripción contienen el texto transcrito, las de subtítulos pueden contener datos SRT o de vídeo renderizado, y los subtítulos contienen el texto de las palabras, startMs/endMs, speakerId que puede ser null y durationSeconds.

​

Uso

​

Errores

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