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"
}
]
}
}
Nutzung und Aktivität
Nutzungsverlauf eines Projekts abrufen
Rufen Sie Minutenabbuchungen, Erstattungen und Lebenszyklusereignisse für Übersetzung und Lippensynchronisation eines Projekts in Ihrem Arbeitsbereich ab.
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"
}
]
}
}
Rufen Sie Minutenabbuchungen, Erstattungen und Lebenszyklusereignisse für Übersetzung und Lippensynchronisation eines Projekts in Ihrem Arbeitsbereich ab.
Erforderliche Berechtigungen:
POST https://api.voicecheap.ai/v1/actions/usage_project_get
Authentifizierung und Berechtigungen
string
erforderlich
Senden Sie einen VoiceCheap-API-Schlüssel in diesem Header. Authorization: Bearer mit demselben API-Schlüssel wird ebenfalls unterstützt.
OAuth-Zugriffstoken werden nur von MCP akzeptiert, nicht von diesem REST-Endpunkt.
usage:read.
Ein aktives kostenpflichtiges Abonnement ist erforderlich. Berechtigungen ändern weder Teamrollen noch Ressourceneigentum, Medienguthaben oder Tariflimits.
Parameter
string
erforderlich
Textwert.Mindestlänge: 1. Höchstlänge: 200. Muster:
^[^/]+$.Vollständiges Eingabeschema
Vollständiges Eingabeschema
Das folgende JSON Schema enthält die exakten Feldnamen, verschachtelten Typen, Standardwerte, Grenzen und akzeptierten Werte aus der Discovery. Zusätzliche feldübergreifende Regeln finden Sie in den Hinweisen zur Operation.
{
"type": "object",
"properties": {
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^/]+$"
}
},
"required": ["projectId"],
"additionalProperties": false
}
Anfragebeispiele
Ersetzen Sie die beispielhaften Ressourcenkennungen und Medienschlüssel durch Werte, die für Ihr Konto zurückgegeben wurden. Behalten Sie bei Wiederholungen derselben Mutation dieselbe Anfragekennung bei.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)
Antwort
Eine erfolgreiche erste Ausführung gibt HTTP 200 mit dem Ergebnis der Operation unter data zurück. Bei einer Wiederholung kann stattdessen der gespeicherte Anfragestatus zurückgegeben werden. Das Beispiel zeigt eine unterstützte Antwort, nicht alle optionalen Felder. Gibt projektweite Minutensummen und Lebenszyklusereignisse über die Übersetzungsdurchläufe des Projekts im aktiven Arbeitsbereich zurück.{
"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"
}
]
}
}
Ergebnisfelder
| Feld | Beschreibung |
|---|---|
data.kind | translation oder project. |
data.isHistoricalDerived | Ob eine oder mehrere Nutzungsangaben aus historischen Daten abgeleitet wurden. |
data.summary.title | Anzeigename des Projekts. |
data.summary.sourceLanguage | Formatierte Quellsprachenbezeichnung, sofern verfügbar. |
data.summary.targetLanguage | Zielsprache für einen Übersetzungslebenszyklus; bei einem Projektlebenszyklus nicht enthalten. |
data.summary.translationStatus | Übersetzungsstatus für einen Übersetzungslebenszyklus; bei einem Projektlebenszyklus ausgelassen. |
data.summary.lipSyncStatus | Status der Lippensynchronisation für einen Übersetzungslebenszyklus; bei einem Projektlebenszyklus ausgelassen. |
data.summary.totals.translationBaseMinutes | Für die übereinstimmenden Zeilen berechnete Basis-Übersetzungsminuten. |
data.summary.totals.lipSyncExtraMinutes | Zusätzlich berechnete Minuten für Standard-Lippensynchronisation. |
data.summary.totals.lipSyncProExtraMinutes | Zusätzlich berechnete Pro-Minuten für Lippensynchronisation. |
data.summary.totals.lipSyncPro2ExtraMinutes | Zusätzlich abgebuchte Minuten für Pro 2-Lippensynchronisation. |
data.summary.totals.totalChargedMinutes | Insgesamt abgebuchte Minuten vor Erstattungen. |
data.summary.totals.refundedMinutes | Erstattete Minuten. |
data.summary.totals.netUsedMinutes | Abgebuchte Minuten abzüglich erstatteter Minuten. |
data.events | Lebenszyklusereignisse in der Reihenfolge ihrer Zeitstempel; Ereignisse ohne Zeitstempel folgen auf Ereignisse mit Zeitstempel. |
data.events[].id | Stabile Ereigniskennung für den gemeldeten Lebenszyklusschritt. |
data.events[].type | Ereignistyp wie project_created, translation_launched, translation_completed oder lip_sync_refunded. |
data.events[].timestamp | Optionaler Ereigniszeitstempel in Millisekunden. |
data.events[].tone | neutral, success, warning oder danger. |
data.events[].relatedRunLabel | Optionale Bezeichnung für Zielsprache und Durchlauf bei Projektlebenszyklusereignissen. |
data.events[].minuteDelta | Optional abgebuchte Minuten als positive Zahl oder erstattete Minuten als negative Zahl. |
data.events[].isDerived | Optionales Kennzeichen für ein aus historischen Daten rekonstruiertes Ereignis. |
Hinweise zur Operation
- Das Projekt muss mindestens eine Nutzungszeile im aktiven Arbeitsbereich haben; ein Projekt ohne Nutzungszeilen gibt einen Fehler zurück.
- Die Zusammenfassung gilt für das gesamte Projekt und enthält keine einzelnen Werte für targetLanguage, translationStatus und lipSyncStatus. Einzelne Ereignisse enthalten gegebenenfalls eine Bezeichnung für Zielsprache und Durchlauf.
- Ereignisse lassen unbearbeitete Verarbeitungsfehlermeldungen und Ereignisanzeigebezeichnungen aus.
Nutzung
Jeder erfolgreiche Aufruf verbraucht einen monatlichen API/MCP-Aufruf. Zusätzlich gelten das Medienguthaben und die eigenen Generierungskontingente der Operation.Fehler
| HTTP-Status | Code | Bedeutung oder Behebung |
|---|---|---|
| 400 | BAD_REQUEST | Das Projekt wurde nicht gefunden oder hat im aktiven Arbeitsbereich keine Übersetzungsnutzungszeilen. |
| 400 | CREDENTIAL_IN_QUERY | Zugangsdaten wurden in einem Abfrageparameter namens access_token oder api_key übergeben. Senden Sie Zugangsdaten in Headern. |
| 400 | VALIDATION_ERROR | Das JSON-Objekt enthält ein nicht unterstütztes Feld, einen ungültigen Wert oder ein fehlendes erforderliches Argument. |
| 401 | API_KEY_EXPIRED | Der API-Schlüssel ist abgelaufen. |
| 401 | INVALID_API_KEY | Geben Sie einen gültigen, nicht abgelaufenen API-Schlüssel an. |
| 401 | INVALID_CREDENTIAL | Der Authorization-Header ist fehlerhaft oder steht im Konflikt mit x-api-key. |
| 401 | MISSING_CREDENTIAL | Es wurde kein nutzbarer Berechtigungsnachweis im Header übergeben, oder er überschritt 4096 Zeichen. |
| 401 | USER_NOT_FOUND | Das Konto des Zugangsnachweises existiert nicht mehr. |
| 403 | AMBIGUOUS_TEAM_API_KEY | Der Benutzer des Berechtigungsnachweises gehört mehr als einem Team an, weshalb der Abrechnungskontext nicht eindeutig ist. |
| 403 | INSUFFICIENT_SCOPE | Erteilen Sie alle erforderlichen Berechtigungen oder verwenden Sie andere Zugangsdaten. |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | Die Integrationslimits des Kontos konnten nicht verifiziert werden. |
| 403 | SUBSCRIPTION_REQUIRED | Verwenden Sie ein aktives kostenpflichtiges Abonnement. |
| 403 | TEAM_MEMBERSHIP_INVALID | Die aktuelle Teammitgliedschaft des Kontos stimmt nicht mit dem Arbeitsbereich dieser Verbindung überein. Aktualisieren Sie die Mitgliedschaft und stellen Sie die Verbindung erneut her. |
| 403 | TEAM_OWNER_NOT_FOUND | Das maßgebliche Konto des Teaminhabers wurde nicht gefunden. |
| 404 | ACCOUNT_NOT_FOUND | Das Konto oder das Konto des aktiven Arbeitsbereichs wurde nicht gefunden. |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | Warten Sie auf die monatliche Zurücksetzung oder wechseln Sie den Tarif. |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | Warten Sie gegebenenfalls die in Retry-After angegebene Zeit und verwenden Sie zunehmend längere Warteintervalle. |
| 500 | INTERNAL_ERROR | Prüfen Sie den Status der gespeicherten Anfrage und den Ressourcenverlauf, bevor Sie eine Mutation erneut versuchen. |
| 503 | SERVER_RESTARTING | Der Server wird neu gestartet. Versuchen Sie es in Kürze erneut und behalten Sie bei einer Mutation dieselbe Anfragekennung bei. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["usage:read"]
}
}
War diese Seite hilfreich?

