Skip to main content
POST
Añade a la cola una edición del texto original o traducido. requestId debe ser un UUID estable para los reintentos. Consulta segment_actions_list para comprobar la finalización.

Autenticación y permisos

string
requerido
Envía una clave de API de VoiceCheap en esta cabecera. También se admite Authorization: Bearer con la misma clave de API. Los tokens de acceso OAuth solo se aceptan en MCP, no en este endpoint REST.
Permisos necesarios: transcription:write. Se requiere una suscripción de pago activa. Los permisos no cambian los roles del equipo, la propiedad de los recursos, los créditos multimedia ni los límites del plan.

Parámetros

string
requerido
Valor de texto.Longitud mínima: 1. Longitud máxima: 200. Patrón: ^[^/\\]+$.
integer
requerido
Valor entero.Mínimo: 0. Máximo: 9007199254740991.
string
Opcional en la capa de transporte: el servidor introduce un identificador antes de la validación si se omite. Proporciona tu propio UUID v4 estable para recuperar la solicitud de forma segura si se pierde la respuesta.Formato: “uuid”. Patrón: ^[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}$.
string
requerido
Valor de texto.Valores permitidos: “original”, “translated”.
string
Valor de texto.Longitud mínima: 1. Longitud máxima: 200. Patrón: ^[^/\\]+$.
string
requerido
Valor de texto.Longitud máxima: 3000.
boolean
Valor booleano.
El JSON Schema siguiente conserva los nombres exactos de los campos, los tipos anidados, los valores predeterminados, los límites y los valores aceptados que expone el descubrimiento. Las reglas adicionales entre campos se indican en las notas de la operación.

Idempotencia

Usa un UUID v4 en requestId o en la cabecera HTTP Idempotency-Key para cada modificación. Reutiliza el mismo identificador y argumentos idénticos después de un fallo de red. Si proporcionas ambos, deben coincidir. Repetir una solicitud guardada no vuelve a ejecutar la operación ni consume otra llamada mensual. Las solicitudes fallidas o interrumpidas no se reinician automáticamente. Toda modificación puede devolver HTTP 202 cuando un reintento encuentra la misma solicitud todavía en ejecución, incluso si su primera ejecución suele ser síncrona. Si la ejecución ha terminado pero resultStored es false, un reintento devuelve HTTP 200 con el estado de la solicitud guardada en lugar del resultado original. Recupera la salida mediante la acción de historial, resultado o descarga de su ámbito.

Ejemplos de solicitud

Sustituye los identificadores de recursos y las claves multimedia de los ejemplos por valores devueltos para tu cuenta. Mantén el identificador de solicitud al reintentar la misma modificación.

Respuesta

Una primera ejecución correcta devuelve HTTP 200 con el resultado de la operación en data. Una repetición puede devolver el estado de la solicitud guardada en su lugar. El ejemplo muestra una respuesta admitida, no todos los campos opcionales. Devuelve la admisión en la cola y una instantánea actualizada de la cola para una edición del texto original o traducido.

Campos del resultado

Recuperar y consultar esta solicitud

Usa el mismo identificador incluso después de perder la conexión. Si resultStored es false, recupera la salida mediante la acción correspondiente de historial, resultado o descarga. Nunca inicies una segunda generación solo para comprobar el progreso.
HTTP 200

Notas de la operación

  • Usa un requestId UUID v4 para la edición prevista y reutilízalo con argumentos idénticos en los reintentos. jobId es igual a este requestId.
  • La admisión devuelve started o queued, no la finalización. Consulta segment_actions_list y busca items[].id igual a jobId hasta que el estado sea completed, failed o cancelled; después, actualiza transcripts_get y projects_get.
  • queue.revision registra el estado de la cola; no es una revisión de la estructura de segmentos de origen. Las acciones de la cola capturan la estructura actual cuando se admiten. Un cambio posterior incompatible en la estructura puede hacer que el elemento falle con SEGMENT_STRUCTURE_CHANGED.
  • Solo se admite una acción pendiente para el mismo destino lógico de segmento. Un requestId nuevo no evita SEGMENT_ACTION_ALREADY_PENDING.
  • Los fallos de ejecución de la cola aparecen como items[].status failed junto con errorCode, en lugar de cambiar el resultado de envío correcto.
  • Para editar el original, omite workId y enableEditing. Las ediciones del texto original marcan ese segmento como pendiente de traducción en todos los trabajos por idioma; no generan automáticamente una nueva voz.
  • Para editar traducciones, usa source translated y proporciona workId. Se requieren tanto el permiso transcription:write como translations:write.
  • enableEditing solo se permite para ediciones de traducciones y activa o desactiva explícitamente el modo de traducción manual. Una edición de traducción actualiza el texto y el estado de edición sin regenerar su voz.
  • El esquema de la acción permite una cadena de texto vacía. Usa la acción específica segments_delete para eliminar un segmento y mantener todos los idiomas alineados.
  • Las respuestas de la cola, incluidas las de envío, cancelación, consulta y repetición, contienen solo metadatos de la acción. Lea el contenido de la transcripción con transcripts_get y el permiso requerido transcription:read.

Uso

Cada invocación correcta consume una llamada mensual de API/MCP. También se aplican los créditos multimedia y las cuotas de generación propias de la operación.

Errores