Importer un média depuis une URL (sous-titres)

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

​

Authentification et autorisations

​

Paramètres

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 4096,
      "format": "uri"
    },
    "filename": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "pattern": "^[^/\\\\\\r\\n\\0]+$"
    },
    "kind": {
      "type": "string",
      "enum": ["transcription", "video_to_srt", "add_subtitles", "animated_captions", "project"]
    },
    "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": ["url", "kind"],
  "additionalProperties": false
}

​

Idempotence

​

Exemples de requêtes

curl --request POST 'https://api.voicecheap.ai/v1/actions/subtitles_upload_import' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"url":"https://media.example.com/interview.mp4","filename":"interview.mp4","kind":"video_to_srt","requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'

const input = {
  url: 'https://media.example.com/interview.mp4',
  filename: 'interview.mp4',
  kind: 'video_to_srt',
  requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/subtitles_upload_import', {
  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/subtitles_upload_import",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"url": "https://media.example.com/interview.mp4", "filename": "interview.mp4", "kind": "video_to_srt", "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": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "status": "running",
    "pollAction": "action_request_get",
    "pollAfterSeconds": 5
  },
  "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}

{
  "data": {
    "fileKey": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4",
    "fileName": "interview.mp4",
    "fileSize": 1048576,
    "durationSeconds": 60,
    "mimeType": "video/mp4",
    "uploadType": "video",
    "readUrl": "https://media.example.com/uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4"
  },
  "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}

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

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

{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "operation": "subtitles_upload_import",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "fileKey": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4",
      "fileName": "interview.mp4",
      "fileSize": 1048576,
      "durationSeconds": 60,
      "mimeType": "video/mp4",
      "uploadType": "video",
      "readUrl": "https://media.example.com/uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4"
    }
  }
}

​

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.
• Pour les outils, les sous-titres et les projets, kind accepte transcription, video_to_srt, add_subtitles, animated_captions ou project. Le champ kind sélectionné détermine les limites du workflow ; le préfixe n’impose pas de kind.
• Le champ kind choisi applique ses propres limites : transcription 200 MiB ; video_to_srt et add_subtitles 300 MiB ; animated_captions 250 MiB et audio uniquement ; project utilise la limite d’envoi de l’offre (Beginner 5 GiB, Starter 10 GiB, Creator 20 GiB, Pro 30 GiB, Scale 40 GiB, Enterprise 60 GiB). Les médias utilisés seuls sont limités à 2 heures. Les sous-titres autorisent 30 minutes avec Beginner et 60 minutes avec les offres publiques supérieures, plus une tolérance de 2 secondes pour le conteneur. La durée d’un projet est limitée à 2 heures, ou 3 heures avec Enterprise.
• Cette action s’exécute de manière asynchrone. Interrogez régulièrement action_request_get avec le nom de l’opération et le requestId d’origine jusqu’à la fin, avant de récupérer fileKey dans le résultat.
• Utilisez une URL HTTPS publique pointant directement vers un fichier audio/vidéo. Les redirections, identifiants de connexion, fragments, ports autres que 443 et adresses DNS non publiques sont rejetés. Une page de lecture YouTube n’est pas une URL directe de média ; utilisez les actions YouTube dédiées.
• filename est facultatif lorsque le chemin de l’URL se termine par un nom de fichier média pris en charge. Le nom de fichier enregistré est nettoyé. Le serveur analyse la durée réelle avant de renvoyer un fileKey.
• L’importation prépare le média et consomme un appel d’intégration mensuel réussi ; le quota quotidien de génération de l’outil est consommé uniquement par la génération suivante.

​

Utilisation

​

Erreurs

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