curl --request POST 'https://api.voicecheap.ai/v1/actions/segment_actions_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_launch_2026"}'
const input = {
projectId: 'project_launch_2026',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/segment_actions_list', {
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/segment_actions_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_launch_2026"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"projectId": "project_launch_2026",
"revision": 3,
"items": [
{
"id": "41321bda-e243-4b6f-96a4-622cd047c991",
"action": {
"type": "text",
"segmentIndex": 0,
"source": "original"
},
"status": "completed",
"createdAt": 1792152000000,
"startedAt": 1792152001000,
"finishedAt": 1792152002000
}
]
}
}
Transcripciones y edición
Obtener las acciones de segmento en cola
Consulta las acciones de edición o regeneración de segmentos de un proyecto que están en cola, en ejecución o completadas.
POST
/
v1
/
actions
/
segment_actions_list
curl --request POST 'https://api.voicecheap.ai/v1/actions/segment_actions_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_launch_2026"}'
const input = {
projectId: 'project_launch_2026',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/segment_actions_list', {
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/segment_actions_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_launch_2026"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"projectId": "project_launch_2026",
"revision": 3,
"items": [
{
"id": "41321bda-e243-4b6f-96a4-622cd047c991",
"action": {
"type": "text",
"segmentIndex": 0,
"source": "original"
},
"status": "completed",
"createdAt": 1792152000000,
"startedAt": 1792152001000,
"finishedAt": 1792152002000
}
]
}
}
Consulta las acciones de edición o regeneración de segmentos de un proyecto que están en cola, en ejecución o completadas.
Permisos necesarios:
POST https://api.voicecheap.ai/v1/actions/segment_actions_list
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.
projects:read.
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:
^[^/\\]+$.Esquema completo de entrada
Esquema completo de entrada
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.
{
"type": "object",
"properties": {
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^/\\\\]+$"
}
},
"required": ["projectId"],
"additionalProperties": false
}
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.curl --request POST 'https://api.voicecheap.ai/v1/actions/segment_actions_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_launch_2026"}'
const input = {
projectId: 'project_launch_2026',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/segment_actions_list', {
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/segment_actions_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_launch_2026"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
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 revisión actual de la cola del proyecto y los elementos de acción públicos en cola, en ejecución y en estado final.{
"data": {
"projectId": "project_launch_2026",
"revision": 3,
"items": [
{
"id": "41321bda-e243-4b6f-96a4-622cd047c991",
"action": {
"type": "text",
"segmentIndex": 0,
"source": "original"
},
"status": "completed",
"createdAt": 1792152000000,
"startedAt": 1792152001000,
"finishedAt": 1792152002000
}
]
}
}
Campos del resultado
| Campo | Descripción |
|---|---|
data.projectId | Identificador del proyecto principal. |
data.revision | Revisión de la instantánea de la cola. Es independiente de projects_get.segmentStructureRevision. |
data.items | Progreso de las acciones del proyecto: identificadores de trabajo, metadatos de la acción, estado, marcas de tiempo y errorCode público opcional. |
data.items[].id | Identificador del trabajo; es igual al requestId del envío original a la cola. |
data.items[].action | Solo metadatos de la acción: type, segmentIndex y, opcionalmente, workId, translatedVersionId y source. No se devuelven el texto enviado, los valores de tiempo ni las instrucciones de regeneración. |
data.items[].status | queued, running, completed, failed o cancelled. |
data.items[].createdAt | Momento de creación del elemento de la cola en milisegundos Unix. |
data.items[].startedAt | Hora opcional del primer inicio en milisegundos Unix. |
data.items[].finishedAt | Hora de finalización opcional en milisegundos Unix. |
data.items[].errorCode | Código de error público opcional. Los errores sin clasificar utilizan ACTION_FAILED. |
data.items[].seenAt | Hora opcional de confirmación únicamente para el usuario autenticado que lo consulta. |
Notas de la operación
- Consulta periódicamente items[].id que coincida con el jobId devuelto por segments_text_update, segments_timestamps_update o segments_regenerate. completed, failed y cancelled son estados terminales.
- revision es la revisión de la cola, no el segmentStructureRevision de origen necesario para eliminar o fusionar.
- Una acción puede devolver un envío exitoso y fallar después en la cola. Consulta items[].errorCode; actualiza el estado del proyecto, la transcripción y la salida afectados antes de decidir realizar una nueva acción.
- Esta operación no tiene parámetros de paginación. Un proyecto sin cola devuelve projectId, revision 0 y un array items vacío.
- 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
| Estado HTTP | Código | Significado o solución |
|---|---|---|
| 400 | CREDENTIAL_IN_QUERY | Se han proporcionado credenciales en un parámetro de consulta access_token o api_key. Envía las credenciales en las cabeceras. |
| 400 | VALIDATION_ERROR | Corrige la entrada según el esquema. Los valores no válidos o incoherentes se rechazan antes de la ejecución. |
| 401 | API_KEY_EXPIRED | La clave API ha caducado. |
| 401 | INVALID_API_KEY | Proporciona una clave de API válida que no haya caducado. |
| 401 | INVALID_CREDENTIAL | La cabecera Authorization tiene un formato incorrecto o entra en conflicto con x-api-key. |
| 401 | MISSING_CREDENTIAL | No se proporcionó ninguna credencial de cabecera utilizable o superaba 4096 caracteres. |
| 401 | USER_NOT_FOUND | La cuenta de la credencial ya no existe. |
| 403 | AMBIGUOUS_TEAM_API_KEY | El usuario de la credencial pertenece a más de un equipo, por lo que el contexto de facturación es ambiguo. |
| 403 | FORBIDDEN | El actor autenticado no puede acceder a este proyecto. |
| 403 | INSUFFICIENT_SCOPE | Concede todos los permisos necesarios o elige otra credencial. |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | No se han podido verificar los límites de integración de la cuenta. |
| 403 | SUBSCRIPTION_REQUIRED | Usa una suscripción de pago activa. |
| 403 | TEAM_OWNER_NOT_FOUND | No se pudo encontrar la cuenta del propietario efectivo del equipo. |
| 404 | PROJECT_NOT_FOUND | El proyecto no existe en la cuenta accesible. |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | Espera al restablecimiento mensual o cambia de plan. |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | Espera el tiempo indicado en Retry-After cuando esté presente y aplica esperas progresivas. |
| 500 | INTERNAL_ERROR | Comprueba el estado de la solicitud guardada y el historial del recurso antes de decidir si reintentas una modificación. |
| 503 | SERVER_RESTARTING | El servidor se está reiniciando. Reinténtalo en breve y conserva el mismo identificador de solicitud para una modificación. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["projects:read"]
}
}
¿Esta página le ayudó?