Lire un résultat d’action de sous-titrage enregistré

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

​

Authentification et autorisations

​

Paramètres

{
  "type": "object",
  "properties": {
    "resultId": {
      "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)$"
    },
    "includeContent": {
      "default": false,
      "type": "boolean"
    }
  },
  "required": ["resultId"],
  "additionalProperties": false
}

​

Exemples de requêtes

curl --request POST 'https://api.voicecheap.ai/v1/actions/subtitles_result_get' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"resultId":"b3caf96f-5f2a-4619-832c-a12c0d57f78b","includeContent":true}'

const input = {
  resultId: 'b3caf96f-5f2a-4619-832c-a12c0d57f78b',
  includeContent: true,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/subtitles_result_get', {
  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_result_get",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b", "includeContent": True},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)

​

Réponse

{
  "data": {
    "resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b",
    "operation": "captions_transcribe",
    "createdAt": 1792152000000,
    "fileName": "voicecheap-captions_transcribe-b3caf96f-5f2a-4619-832c-a12c0d57f78b.json",
    "byteLength": 190,
    "contentType": "application/json; charset=utf-8",
    "status": "completed",
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "getAction": "subtitles_result_get",
    "downloadAction": "subtitles_result_download",
    "listAction": "subtitles_result_list",
    "result": {
      "words": [
        {
          "text": "Hello",
          "startMs": 0,
          "endMs": 500,
          "speakerId": "speaker_0"
        },
        {
          "text": "world.",
          "startMs": 500,
          "endMs": 1500,
          "speakerId": "speaker_0"
        }
      ],
      "detectedLanguage": "en",
      "durationSeconds": 60
    }
  }
}

​

Champs du résultat

​

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.
• resultId est un UUID provenant d’une référence de génération terminée ou de result_list pour ce domaine. Il diffère du requestId de l’action et du historyId de l’outil web.
• Les résultats appartiennent à l’utilisateur authentifié et au domaine d’autorisation. Un résultat subtitles ne peut pas être lu via les actions transcription, ni inversement.
• Le JSON complet enregistré est chiffré au repos et conservé indépendamment du cache limité d’interrogation des actions. Sa récupération reste authentifiée ; aucune URL publique de JSON de transcription ou de sous-titres n’est émise.
• Ces actions récupèrent des résultats existants et ne génèrent pas de média ni ne consomment de quota quotidien. Chaque récupération réussie utilise toutefois un appel d’intégration mensuel.
• Le statut pending des métadonnées signifie que la persistance de la sortie nécessite une récupération. La lecture du contenu ou le téléchargement tente de récupérer un objet chiffré déjà enregistré ; vérifiez-le avant de lancer une autre génération.
• includeContent vaut false par défaut. true déchiffre et renvoie l’intégralité du JSON généré sous result. Cet exemple montre la forme qui renvoie le contenu.
• La structure du résultat imbriqué suit celle de son opération d’origine. Les sorties de transcription contiennent le texte de la transcription, celles de sous-titres peuvent contenir des données SRT ou de vidéo rendue, et les sous-titres mot à mot contiennent le texte des mots, startMs/endMs, speakerId pouvant valoir null et durationSeconds.

​

Utilisation

​

Erreurs

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