Skip to main content

​
Referencia de la API

La API de VoiceCheap utiliza métodos y códigos de estado HTTP estándar. La mayoría de los endpoints devuelven JSON; las exportaciones de transcripciones también pueden devolver SRT o VTT. Para la configuración de la cuenta, la gestión del equipo, las herramientas multimedia y otros flujos de trabajo, usa el catálogo de acciones. Estos flujos también están disponibles mediante el servidor MCP de la cuenta, excepto la creación y rotación del secreto de firma de webhooks, que requieren REST. Gestiona las credenciales en Integraciones y consulta los límites de uso.

​
URL base

Todas las solicitudes a la API deben realizarse a:

​
Autenticación

Autentica las llamadas REST privadas con una clave de API en x-api-key o Authorization: Bearer. El documento OpenAPI es público. Consulta Autenticación para obtener información sobre las credenciales con permisos específicos y OAuth para MCP.

​
API de acciones JSON

Las secciones de cuenta, equipo, proyectos, voces y herramientas multimedia documentan cada acción JSON por separado. Todas estas rutas usan POST, también para consultar y eliminar; envía los argumentos en el cuerpo JSON. Las rutas de subida de archivos y de proyectos existentes que aparecen abajo conservan sus propios métodos HTTP. Crea una clave API con account:read, define la variable de entorno VOICECHEAP_API_KEY y prueba esta solicitud de solo lectura:
Una acción completada devuelve HTTP 200 con el resultado en data. Una acción larga devuelve HTTP 202 y un requestId; consulta el estado de la solicitud para recuperar el resultado. Una tarea multimedia puede continuar después de que termine la solicitud de acción. Consulta todas las acciones por área o descubre las acciones y esquemas permitidos para tu clave. Cada página especifica permisos, parámetros, ejemplos y errores.

​
Tipos de contenido

  • Solicitud: Utilice multipart/form-data para cargas de archivos, application/json para otras solicitudes
  • Respuesta: Los puntos finales JSON devuelven application/json. Las exportaciones de transcripciones también pueden devolver texto SRT o VTT.

​
Subida de archivos y rutas de proyectos existentes

Transcribir medio

POST /v1/transcribeTranscriba un archivo cargado como JSON, SRT o VTT.

Exportar transcripción del proyecto

POST /v1/projects/{projectId}/transcriptRecupere transcripciones de proyectos originales o traducidas.

Crear proyecto

POST /v1/projectsSuba un archivo de vídeo o audio e inicie solo la transcripción.

Iniciar traducción

POST /v1/translateCargue un archivo de video o audio e inicie un proyecto de traducción.

Doblar proyecto

POST /v1/projects/{projectId}/dubDoble un proyecto transcrito con su propio archivo SRT traducido.

Obtener estado de la traducción

GET /v1/translate/{projectId}/statusVerifique el estado de un proyecto de traducción y recupere los resultados.

Obtener detalles del proyecto

GET /v1/projects/{projectId}Recupere el historial de versiones traducidas, el historial de sincronización labial y el estado del proyecto.

Eliminar proyecto

DELETE /v1/translate/{projectId}Elimine permanentemente un proyecto de traducción y sus activos.

​
Flujo de trabajo de traducción

El flujo de trabajo típico para traducir un video es:

​
Formato de respuesta

Las rutas existentes de subida de archivos y proyectos que aparecen abajo mantienen sus formatos de respuesta específicos. Los campos de una respuesta correcta dependen del endpoint. Las solicitudes para crear un proyecto o iniciar el doblaje devuelven success, message y projectId. Las consultas de estado y detalles devuelven el estado del proyecto; las solicitudes de transcripción devuelven JSON, SRT o VTT. Consulte la página de cada endpoint para ver su respuesta exacta. Los errores devuelven un objeto JSON con code y message, a veces también con details. Consulte Códigos de error.

​
Códigos de estado HTTP