Annuler un envoi de média (échantillons de voix)

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

​

Authentification et autorisations

​

Paramètres

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

​

Idempotence

​

Exemples de requêtes

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)

​

Réponse

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

​

Champs du résultat

​

Récupérer et suivre cette requête

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

​

Notes de l’opération

• Nécessite un abonnement payant et l’autorisation de l’action. L’offre personnelle d’outils de l’acteur est vérifiée de nouveau à l’exécution ; les outils enregistrés et les références d’envoi appartiennent à cet acteur, y compris lorsque l’identifiant d’accès est associé à une équipe.
• Une action réussie consomme un appel mensuel API/MCP partagé. Beginner autorise 500 appels/mois, Starter 5,000 et Creator 25,000 ; Pro, Scale et Enterprise n’ont pas de plafond mensuel. Les limites par minute restent applicables : respectivement 30, 60, 120, 180, 300 et 600. Les quotas de génération des outils sont distincts.
• Utilisez un requestId au format UUID v4, ou un en-tête Idempotency-Key identique, et conservez la même action, le même identifiant et les mêmes arguments lors des nouvelles tentatives. La restitution d’un résultat en cache ne consomme pas d’appel mensuel supplémentaire.
• Le préfixe d’envoi détermine l’autorisation requise. tools utilise transcription:write, subtitles utilise subtitles:write, projects utilise projects:write et voices utilise voices:write.
• Les échantillons vocaux prennent uniquement en charge les formats audio MP3, WAV, M4A, OGG ou Opus et sont limités à 20 MiB (20,971,520 octets). Le type MIME doit être l’un des types audio documentés. kind vaut voice_sample par défaut ; cette famille n’a pas d’action upload_import.
• Utilisez le fileKey de l’échantillon dont l’envoi est terminé avec l’action de création de voix appropriée. L’envoi seul ne crée pas de voix et ne génère pas de parole.
• La signature, la finalisation et l’annulation des envois de voix vérifient aussi que la session existante est audio et ne dépasse pas 20 MiB ; cette autorisation ne permet pas d’utiliser une autre session plus volumineuse ou vidéo.
• L’annulation abandonne les parties déjà envoyées de l’envoi multipartie et supprime la session active. Une session déjà absente renvoie success: true.
• L’abandon ne supprime pas un objet média déjà finalisé et ne rembourse ni ne modifie un quota de génération.

​

Utilisation

​

Erreurs

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