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"
}
]
}
}
Wykorzystanie i aktywność
Pobierz cykl wykorzystania projektu
Pobierz naliczenia minut tłumaczenia i synchronizacji ruchu ust, zwroty oraz zdarzenia cyklu życia projektu w swoim obszarze roboczym.
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"
}
]
}
}
Pobierz naliczenia minut tłumaczenia i synchronizacji ruchu ust, zwroty oraz zdarzenia cyklu życia projektu w swoim obszarze roboczym.
Wymagane uprawnienia:
POST https://api.voicecheap.ai/v1/actions/usage_project_get
Uwierzytelnianie i uprawnienia
string
wymagane
Wyślij klucz API VoiceCheap w tym nagłówku. Obsługiwany jest również nagłówek Authorization: Bearer z tym samym kluczem API. Tokeny dostępu OAuth są
akceptowane tylko przez MCP, a nie przez ten endpoint REST.
usage:read.
Wymagana jest aktywna płatna subskrypcja. Uprawnienia nie zmieniają ról w zespole, własności zasobów, kredytów na multimedia ani limitów planu.
Parametry
string
wymagane
Wartość tekstowa.Minimalna długość: 1. Maksymalna długość: 200. Wzorzec:
^[^/]+$.Pełny schemat danych wejściowych
Pełny schemat danych wejściowych
Poniższy JSON Schema zachowuje dokładne nazwy pól, typy zagnieżdżone, wartości domyślne, ograniczenia i akceptowane wartości udostępniane przez mechanizm wykrywania. Dodatkowe reguły zależności między polami znajdują się w uwagach do operacji.
{
"type": "object",
"properties": {
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^/]+$"
}
},
"required": ["projectId"],
"additionalProperties": false
}
Przykłady żądań
Zastąp przykładowe identyfikatory zasobów i klucze multimediów wartościami zwróconymi dla Twojego konta. Przy ponawianiu tej samej operacji zmieniającej dane zachowaj identyfikator żądania.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)
Odpowiedź
Pierwsze pomyślne wykonanie zwraca HTTP 200 z wynikiem operacji w data. Ponowienie może zamiast tego zwrócić zapisany stan żądania. Przykład przedstawia jedną obsługiwaną odpowiedź, bez wszystkich opcjonalnych pól. Zwraca sumy minut dla całego projektu i zdarzenia cyklu życia ze wszystkich jego przebiegów tłumaczenia w aktywnym obszarze roboczym.{
"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"
}
]
}
}
Pola wyniku
| Pole | Opis |
|---|---|
data.kind | translation lub project. |
data.isHistoricalDerived | Czy co najmniej jeden szczegół wykorzystania został wyprowadzony z danych historycznych. |
data.summary.title | Wyświetlana nazwa projektu. |
data.summary.sourceLanguage | Sformatowana etykieta języka źródłowego, jeśli jest dostępna. |
data.summary.targetLanguage | Język docelowy cyklu życia tłumaczenia; pomijany w cyklu życia projektu. |
data.summary.translationStatus | Stan tłumaczenia w cyklu przetwarzania tłumaczenia; pomijany w cyklu przetwarzania projektu. |
data.summary.lipSyncStatus | Status synchronizacji ruchu ust dla cyklu życia tłumaczenia; pomijany w cyklu życia projektu. |
data.summary.totals.translationBaseMinutes | Podstawowe minuty tłumaczenia naliczone łącznie dla pasujących wierszy. |
data.summary.totals.lipSyncExtraMinutes | Dodatkowe naliczone minuty synchronizacji ruchu ust Standard. |
data.summary.totals.lipSyncProExtraMinutes | Dodatkowe naliczone minuty synchronizacji ruchu ust Pro. |
data.summary.totals.lipSyncPro2ExtraMinutes | Dodatkowo naliczone minuty synchronizacji ruchu ust Pro 2. |
data.summary.totals.totalChargedMinutes | Łączna liczba naliczonych minut przed zwrotami. |
data.summary.totals.refundedMinutes | Zwrócone minuty. |
data.summary.totals.netUsedMinutes | Naliczone minuty pomniejszone o zwrócone minuty. |
data.events | Zdarzenia cyklu życia w kolejności znaczników czasu; zdarzenia bez znaczników czasu następują po zdarzeniach ze znacznikami czasu. |
data.events[].id | Stały identyfikator zdarzenia dla zgłaszanego etapu cyklu życia. |
data.events[].type | Typ zdarzenia, na przykład project_created, translation_launched, translation_completed lub lip_sync_refunded. |
data.events[].timestamp | Opcjonalny znacznik czasu zdarzenia w milisekundach. |
data.events[].tone | neutral, success, warning lub danger. |
data.events[].relatedRunLabel | Opcjonalna etykieta języka docelowego i przebiegu dla zdarzeń cyklu życia projektu. |
data.events[].minuteDelta | Opcjonalne naliczone minuty jako liczba dodatnia lub zwrócone minuty jako liczba ujemna. |
data.events[].isDerived | Opcjonalna flaga wskazująca zdarzenie odtworzone z danych historycznych. |
Uwagi do operacji
- Projekt musi mieć co najmniej jeden wiersz zużycia w aktywnym obszarze roboczym; projekt bez wierszy zużycia zwraca błąd.
- Podsumowanie obejmuje cały projekt i pomija pojedyncze targetLanguage, translationStatus i lipSyncStatus. Poszczególne zdarzenia zawierają etykietę języka docelowego lub przebiegu, jeśli dotyczy.
- Zdarzenia pomijają surowe komunikaty błędów przetwarzania i etykiety wyświetlania zdarzeń.
Wykorzystanie
Każde pomyślne wywołanie zużywa jedno wywołanie z miesięcznego limitu API/MCP. Obowiązują również kredyty na multimedia oraz limity generowania danej operacji.Błędy
| Status HTTP | Kod | Znaczenie lub sposób rozwiązania |
|---|---|---|
| 400 | BAD_REQUEST | Nie znaleziono projektu lub nie ma on wierszy zużycia tłumaczenia w aktywnym obszarze roboczym. |
| 400 | CREDENTIAL_IN_QUERY | Dane uwierzytelniające zostały podane w parametrze zapytania access_token lub api_key. Wysyłaj dane uwierzytelniające w nagłówkach. |
| 400 | VALIDATION_ERROR | Obiekt JSON zawiera nieobsługiwane pole, nieprawidłową wartość lub brakuje w nim wymaganego argumentu. |
| 401 | API_KEY_EXPIRED | Klucz API wygasł. |
| 401 | INVALID_API_KEY | Podaj prawidłowy, niewygasły klucz API. |
| 401 | INVALID_CREDENTIAL | Nagłówek Authorization ma nieprawidłowy format lub jest sprzeczny z x-api-key. |
| 401 | MISSING_CREDENTIAL | Nie podano użytecznych danych uwierzytelniających w nagłówku lub przekroczyły one 4096 znaków. |
| 401 | USER_NOT_FOUND | Konto powiązane z poświadczeniem już nie istnieje. |
| 403 | AMBIGUOUS_TEAM_API_KEY | Użytkownik, do którego należą dane uwierzytelniające, należy do więcej niż jednego zespołu, więc kontekst rozliczeniowy jest niejednoznaczny. |
| 403 | INSUFFICIENT_SCOPE | Nadaj wszystkie wymagane uprawnienia lub wybierz inne dane uwierzytelniające. |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | Nie udało się zweryfikować limitów integracji konta. |
| 403 | SUBSCRIPTION_REQUIRED | Użyj aktywnej płatnej subskrypcji. |
| 403 | TEAM_MEMBERSHIP_INVALID | Bieżące członkostwo konta w zespole nie odpowiada obszarowi roboczemu tego połączenia. Odśwież członkostwo i połącz się ponownie. |
| 403 | TEAM_OWNER_NOT_FOUND | Nie znaleziono konta faktycznego właściciela zespołu. |
| 404 | ACCOUNT_NOT_FOUND | Nie znaleziono konta lub konta aktywnego obszaru roboczego. |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | Poczekaj na odnowienie miesięcznego limitu lub zmień plan. |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | Jeśli występuje nagłówek Retry-After, odczekaj wskazany czas i stosuj rosnące odstępy między ponowieniami. |
| 500 | INTERNAL_ERROR | Sprawdź stan zapisanego żądania i historię zasobu przed podjęciem decyzji o ponowieniu operacji zmieniającej dane. |
| 503 | SERVER_RESTARTING | Serwer jest uruchamiany ponownie. Spróbuj ponownie wkrótce i zachowaj ten sam identyfikator żądania dla operacji zmieniającej dane. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["usage:read"]
}
}
Czy ta strona była pomocna?

