curl --request POST 'https://api.voicecheap.ai/v1/actions/usage_project_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_123"}'
const input = {
projectId: 'project_123',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/usage_project_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/usage_project_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_123"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"kind": "project",
"isHistoricalDerived": false,
"summary": {
"title": "Product launch",
"sourceLanguage": "English",
"totals": {
"translationBaseMinutes": 2,
"lipSyncExtraMinutes": 0,
"lipSyncProExtraMinutes": 0,
"lipSyncPro2ExtraMinutes": 0,
"totalChargedMinutes": 2,
"refundedMinutes": 0,
"netUsedMinutes": 2
}
},
"events": [
{
"id": "project_123-project-created",
"type": "project_created",
"timestamp": 1792065540000,
"tone": "neutral"
},
{
"id": "version_123-translation-launched",
"type": "translation_launched",
"timestamp": 1792065600000,
"tone": "neutral",
"minuteDelta": 2,
"relatedRunLabel": "French"
},
{
"id": "version_123-translation-completed",
"type": "translation_completed",
"timestamp": 1792065720000,
"tone": "success",
"isDerived": false,
"relatedRunLabel": "French"
}
]
}
}
Utilisation et activité
Consulter le cycle d’utilisation d’un projet
Consultez les débits de minutes de traduction et de synchronisation labiale, les remboursements et les événements du cycle de vie d’un projet dans votre espace de travail.
POST
/
v1
/
actions
/
usage_project_get
curl --request POST 'https://api.voicecheap.ai/v1/actions/usage_project_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_123"}'
const input = {
projectId: 'project_123',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/usage_project_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/usage_project_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_123"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"kind": "project",
"isHistoricalDerived": false,
"summary": {
"title": "Product launch",
"sourceLanguage": "English",
"totals": {
"translationBaseMinutes": 2,
"lipSyncExtraMinutes": 0,
"lipSyncProExtraMinutes": 0,
"lipSyncPro2ExtraMinutes": 0,
"totalChargedMinutes": 2,
"refundedMinutes": 0,
"netUsedMinutes": 2
}
},
"events": [
{
"id": "project_123-project-created",
"type": "project_created",
"timestamp": 1792065540000,
"tone": "neutral"
},
{
"id": "version_123-translation-launched",
"type": "translation_launched",
"timestamp": 1792065600000,
"tone": "neutral",
"minuteDelta": 2,
"relatedRunLabel": "French"
},
{
"id": "version_123-translation-completed",
"type": "translation_completed",
"timestamp": 1792065720000,
"tone": "success",
"isDerived": false,
"relatedRunLabel": "French"
}
]
}
}
Consultez les débits de minutes de traduction et de synchronisation labiale, les remboursements et les événements du cycle de vie d’un projet dans votre espace de travail.
Autorisations requises:
POST https://api.voicecheap.ai/v1/actions/usage_project_get
Authentification et autorisations
string
requis
Envoyez une clé API VoiceCheap dans cet en-tête. Authorization: Bearer avec la même clé API est également accepté. Les jetons d’accès OAuth sont
acceptés uniquement par MCP, pas par cet endpoint REST.
usage:read.
Un abonnement payant actif est requis. Les autorisations ne modifient ni les rôles dans l’équipe, ni la propriété des ressources, ni les crédits média, ni les limites du forfait.
Paramètres
string
requis
Valeur textuelle.Longueur minimale: 1. Longueur maximale: 200. Motif:
^[^/]+$.Schéma d’entrée complet
Schéma d’entrée complet
Le JSON Schema ci-dessous conserve les noms de champs exacts, les types imbriqués, les valeurs par défaut, les limites et les valeurs acceptées exposés par la découverte. Les règles supplémentaires entre champs figurent dans les notes de l’opération.
{
"type": "object",
"properties": {
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^/]+$"
}
},
"required": ["projectId"],
"additionalProperties": false
}
Exemples de requêtes
Remplacez les exemples d’identifiants de ressources et de clés média par des valeurs renvoyées pour votre compte. Conservez le même identifiant de requête lorsque vous réessayez la même mutation.curl --request POST 'https://api.voicecheap.ai/v1/actions/usage_project_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_123"}'
const input = {
projectId: 'project_123',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/usage_project_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/usage_project_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_123"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
Réponse
Une première exécution réussie renvoie HTTP 200 avec le résultat de l’opération sous data. Une nouvelle tentative peut renvoyer à la place l’état de la requête enregistrée. L’exemple présente une réponse possible, sans tous les champs facultatifs. Renvoie les totaux de minutes du projet et les événements du cycle de vie de ses exécutions de traduction dans l’espace de travail actif.{
"data": {
"kind": "project",
"isHistoricalDerived": false,
"summary": {
"title": "Product launch",
"sourceLanguage": "English",
"totals": {
"translationBaseMinutes": 2,
"lipSyncExtraMinutes": 0,
"lipSyncProExtraMinutes": 0,
"lipSyncPro2ExtraMinutes": 0,
"totalChargedMinutes": 2,
"refundedMinutes": 0,
"netUsedMinutes": 2
}
},
"events": [
{
"id": "project_123-project-created",
"type": "project_created",
"timestamp": 1792065540000,
"tone": "neutral"
},
{
"id": "version_123-translation-launched",
"type": "translation_launched",
"timestamp": 1792065600000,
"tone": "neutral",
"minuteDelta": 2,
"relatedRunLabel": "French"
},
{
"id": "version_123-translation-completed",
"type": "translation_completed",
"timestamp": 1792065720000,
"tone": "success",
"isDerived": false,
"relatedRunLabel": "French"
}
]
}
}
Champs du résultat
| Champ | Description |
|---|---|
data.kind | translation ou project. |
data.isHistoricalDerived | Indique si un ou plusieurs détails d’utilisation ont été déduits de données historiques. |
data.summary.title | Nom d’affichage du projet. |
data.summary.sourceLanguage | Libellé formaté de la langue source, si disponible. |
data.summary.targetLanguage | Langue cible du cycle de vie d’une traduction ; omise pour le cycle de vie d’un projet. |
data.summary.translationStatus | État de traduction pour un cycle de traduction ; omis pour un cycle de projet. |
data.summary.lipSyncStatus | Statut de synchronisation labiale pour un cycle de traduction ; omis pour un cycle de projet. |
data.summary.totals.translationBaseMinutes | Minutes de traduction de base décomptées pour l’ensemble des lignes correspondantes. |
data.summary.totals.lipSyncExtraMinutes | Minutes supplémentaires de synchronisation labiale Standard facturées. |
data.summary.totals.lipSyncProExtraMinutes | Minutes supplémentaires de synchronisation labiale Pro facturées. |
data.summary.totals.lipSyncPro2ExtraMinutes | Minutes supplémentaires de synchronisation labiale Pro 2 débitées. |
data.summary.totals.totalChargedMinutes | Total des minutes débitées avant remboursements. |
data.summary.totals.refundedMinutes | Minutes remboursées. |
data.summary.totals.netUsedMinutes | Minutes débitées moins les minutes remboursées. |
data.events | Événements du cycle de vie classés par horodatage ; les événements sans horodatage suivent les événements horodatés. |
data.events[].id | Identifiant d’événement stable pour l’étape du cycle de vie signalée. |
data.events[].type | Type d’événement, par exemple project_created, translation_launched, translation_completed ou lip_sync_refunded. |
data.events[].timestamp | Horodatage facultatif de l’événement en millisecondes. |
data.events[].tone | neutral, success, warning ou danger. |
data.events[].relatedRunLabel | Libellé facultatif de langue cible et d’exécution pour les événements du cycle de vie du projet. |
data.events[].minuteDelta | Minutes débitées facultatives sous forme de nombre positif, ou minutes remboursées sous forme de nombre négatif. |
data.events[].isDerived | Indicateur facultatif signalant un événement reconstitué à partir de données historiques. |
Notes de l’opération
- Le projet doit posséder au moins une ligne d’utilisation dans l’espace de travail actif ; un projet sans ligne d’utilisation renvoie une erreur.
- Le résumé concerne l’ensemble du projet et omet les champs individuels targetLanguage, translationStatus et lipSyncStatus. Les événements individuels incluent un libellé de langue cible ou d’exécution lorsque cela s’applique.
- Les événements omettent les messages d’erreur de traitement bruts et les libellés d’affichage des événements.
Utilisation
Chaque invocation réussie consomme un appel du quota mensuel API/MCP. Les crédits média et les quotas de génération propres à l’opération s’appliquent également.Erreurs
| Statut HTTP | Code | Signification ou solution |
|---|---|---|
| 400 | BAD_REQUEST | Le projet est introuvable ou ne possède aucune ligne d’utilisation de traduction dans l’espace de travail actif. |
| 400 | CREDENTIAL_IN_QUERY | Des identifiants ont été fournis dans un paramètre de requête access_token ou api_key. Envoyez les identifiants dans les en-têtes. |
| 400 | VALIDATION_ERROR | L’objet JSON contient un champ non pris en charge, une valeur invalide ou un argument obligatoire manquant. |
| 401 | API_KEY_EXPIRED | La clé API a expiré. |
| 401 | INVALID_API_KEY | Fournissez une clé API valide et non expirée. |
| 401 | INVALID_CREDENTIAL | L’en-tête Authorization est mal formé ou entre en conflit avec x-api-key. |
| 401 | MISSING_CREDENTIAL | Aucun identifiant d’authentification utilisable n’a été fourni dans les en-têtes, ou il dépassait 4096 caractères. |
| 401 | USER_NOT_FOUND | Le compte associé à l’identifiant d’accès n’existe plus. |
| 403 | AMBIGUOUS_TEAM_API_KEY | L’utilisateur associé aux identifiants d’authentification appartient à plusieurs équipes, ce qui rend le contexte de facturation ambigu. |
| 403 | INSUFFICIENT_SCOPE | Accordez toutes les autorisations requises ou choisissez d’autres identifiants d’accès. |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | Les limites d’intégration du compte n’ont pas pu être vérifiées. |
| 403 | SUBSCRIPTION_REQUIRED | Utilisez un abonnement payant actif. |
| 403 | TEAM_MEMBERSHIP_INVALID | L’appartenance actuelle du compte à une équipe ne correspond pas à l’espace de travail de cette connexion. Actualisez l’appartenance et reconnectez-vous. |
| 403 | TEAM_OWNER_NOT_FOUND | Le compte du propriétaire effectif de l’équipe est introuvable. |
| 404 | ACCOUNT_NOT_FOUND | Le compte ou le compte de l’espace de travail actif est introuvable. |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | Attendez la réinitialisation mensuelle ou changez de forfait. |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | Respectez Retry-After lorsqu’il est présent et espacez progressivement les nouvelles tentatives. |
| 500 | INTERNAL_ERROR | Vérifiez l’état de la requête enregistrée et l’historique de la ressource avant de décider de réessayer une mutation. |
| 503 | SERVER_RESTARTING | Le serveur redémarre. Réessayez dans un instant en conservant le même identifiant de requête pour une mutation. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["usage:read"]
}
}
Cette page vous a-t-elle été utile ?

