Cancelar una carga multimedia (muestras de voz)

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

​

Autenticación y permisos

​

Parámetros

{
  "type": "object",
  "properties": {
    "uploadId": {
      "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)$"
    },
    "requestId": {
      "description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries.",
      "type": "string",
      "format": "uuid",
      "pattern": "^[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}$"
    }
  },
  "required": ["uploadId"],
  "additionalProperties": false
}

​

Idempotencia

​

Ejemplos de solicitud

curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_upload_abort' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"uploadId":"a1b2c3d4-e5f6-4789-8abc-def012345678","requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'

const input = {
  uploadId: 'a1b2c3d4-e5f6-4789-8abc-def012345678',
  requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_upload_abort', {
  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/voices_upload_abort",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"uploadId": "a1b2c3d4-e5f6-4789-8abc-def012345678", "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)

​

Respuesta

{
  "data": {
    "success": true
  },
  "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}

{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "operation": "voices_upload_abort",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "running",
    "pollAfterSeconds": 5
  },
  "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}

{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "operation": "voices_upload_abort",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "completed",
    "resultStored": false,
    "message": "The action completed. Retrieve its output from the corresponding history or resource action."
  },
  "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}

​

Campos del resultado

​

Recuperar y consultar esta solicitud

curl --request POST 'https://api.voicecheap.ai/v1/actions/action_request_get' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"requestId":"13579bdf-2468-4ace-8bdf-0123456789ab","operation":"voices_upload_abort"}'

{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "operation": "voices_upload_abort",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "success": true
    }
  }
}

​

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.
• Usa un requestId UUID v4 o un encabezado Idempotency-Key idéntico, y conserva la misma acción, el mismo ID y los mismos argumentos en los reintentos. Una repetición desde la caché no consume otra llamada mensual.
• El prefijo de carga determina el permiso requerido. tools usa transcription:write, subtitles usa subtitles:write, projects usa projects:write y voices usa voices:write.
• Las muestras de voz solo admiten audio MP3, WAV, M4A, OGG u Opus y están limitadas a 20 MiB (20,971,520 bytes). El tipo MIME debe ser uno de los tipos de audio documentados. kind tiene voice_sample como valor predeterminado; esta familia no tiene una acción upload_import.
• Usa el fileKey de la muestra completada con la acción de creación de voz correspondiente. La carga por sí sola no crea una voz ni genera voz.
• La firma, la finalización y la anulación de subidas de voz también comprueban que la sesión existente sea de audio y no supere 20 MiB; este permiso no permite utilizar una sesión ajena de mayor tamaño o de vídeo.
• La anulación descarta las partes de la subida multiparte y elimina la sesión activa. Una sesión que ya no existe devuelve success: true.
• La cancelación no elimina un objeto multimedia ya completado ni reembolsa o modifica la cuota de generación.

​

Uso

​

Errores

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