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

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

​

Authentification et autorisations

​

Paramètres

{
  "type": "object",
  "properties": {
    "filename": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "pattern": "^[^/\\\\\\r\\n\\0]+$"
    },
    "contentType": {
      "type": "string",
      "enum": ["audio/mpeg", "audio/mp3", "audio/wav", "audio/x-wav", "audio/mp4", "audio/x-m4a", "audio/ogg", "audio/opus", "audio/x-opus"]
    },
    "fileSize": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 20971520
    },
    "kind": {
      "default": "voice_sample",
      "type": "string",
      "const": "voice_sample"
    },
    "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": ["filename", "contentType", "fileSize"],
  "additionalProperties": false
}

​

Idempotence

​

Exemples de requêtes

curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_upload_initialize' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"filename":"voice-sample.wav","contentType":"audio/wav","fileSize":1048576,"kind":"voice_sample","requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'

const input = {
  filename: 'voice-sample.wav',
  contentType: 'audio/wav',
  fileSize: 1048576,
  kind: 'voice_sample',
  requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_upload_initialize', {
  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_initialize",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"filename": "voice-sample.wav", "contentType": "audio/wav", "fileSize": 1048576, "kind": "voice_sample", "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": {
    "uploadId": "a1b2c3d4-e5f6-4789-8abc-def012345678",
    "key": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-voice-sample.wav",
    "partSize": 5242880,
    "maxConcurrency": 4
  },
  "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}

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

{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "operation": "voices_upload_initialize",
    "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_initialize"}'

{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "operation": "voices_upload_initialize",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "uploadId": "a1b2c3d4-e5f6-4789-8abc-def012345678",
      "key": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-voice-sample.wav",
      "partSize": 5242880,
      "maxConcurrency": 4
    }
  }
}

​

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.
• Le nom de fichier d’entrée doit être un nom de fichier unique, sans barres obliques, barres obliques inverses, CR, LF ni NUL. contentType doit être un type MIME audio/vidéo pris en charge, ou application/octet-stream pour les envois autres que les échantillons vocaux.
• L’initialisation renvoie key, et non fileKey. Conservez uploadId séparément ; il s’agit de l’UUID utilisé pour la signature, la finalisation et l’abandon.
• partSize est choisi entre 5 MiB et 100 MiB. Calculez le nombre de parties avec ceil(fileSize / partSize), utilisez au maximum maxConcurrency PUT simultanés et conservez chaque ETag renvoyé.
• Les sessions d’envoi expirent après 24 heures. La préparation d’un envoi ne consomme pas de quota quotidien de génération.

​

Utilisation

​

Erreurs

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