curl --request POST 'https://api.voicecheap.ai/v1/actions/folders_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"folderId":"624f6bb2-e06f-4353-8d6a-33d15f34c5c2","includeProjectMetrics":true}'
const input = {
folderId: '624f6bb2-e06f-4353-8d6a-33d15f34c5c2',
includeProjectMetrics: true,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/folders_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/folders_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"folderId": "624f6bb2-e06f-4353-8d6a-33d15f34c5c2", "includeProjectMetrics": True},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"folderId": "624f6bb2-e06f-4353-8d6a-33d15f34c5c2",
"folderName": "Product videos",
"projectIds": [
"project_123"
],
"dateCreated": 1792065600000,
"translationInstructions": "Keep product names unchanged.",
"projectMetrics": {
"projectsCount": 1,
"totalDurationSeconds": 120,
"translatedProjectsCount": 1,
"translationsInProgressProjectsCount": 0,
"awaitingProofreadingProjectsCount": 0
}
}
}
Foldery
Pobierz folder
Pobierz nazwę folderu, instrukcje tłumaczenia, identyfikatory projektów i opcjonalne metryki projektów w aktywnym obszarze roboczym.
POST
/
v1
/
actions
/
folders_get
curl --request POST 'https://api.voicecheap.ai/v1/actions/folders_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"folderId":"624f6bb2-e06f-4353-8d6a-33d15f34c5c2","includeProjectMetrics":true}'
const input = {
folderId: '624f6bb2-e06f-4353-8d6a-33d15f34c5c2',
includeProjectMetrics: true,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/folders_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/folders_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"folderId": "624f6bb2-e06f-4353-8d6a-33d15f34c5c2", "includeProjectMetrics": True},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"folderId": "624f6bb2-e06f-4353-8d6a-33d15f34c5c2",
"folderName": "Product videos",
"projectIds": [
"project_123"
],
"dateCreated": 1792065600000,
"translationInstructions": "Keep product names unchanged.",
"projectMetrics": {
"projectsCount": 1,
"totalDurationSeconds": 120,
"translatedProjectsCount": 1,
"translationsInProgressProjectsCount": 0,
"awaitingProofreadingProjectsCount": 0
}
}
}
Pobierz nazwę folderu, instrukcje tłumaczenia, identyfikatory projektów i opcjonalne metryki projektów w aktywnym obszarze roboczym.
Wymagane uprawnienia:
POST https://api.voicecheap.ai/v1/actions/folders_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.
folders: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:
^[^/]+$.boolean
Wartość logiczna.Wartość domyślna: false.
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": {
"folderId": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^/]+$"
},
"includeProjectMetrics": {
"default": false,
"type": "boolean"
}
},
"required": ["folderId"],
"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/folders_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"folderId":"624f6bb2-e06f-4353-8d6a-33d15f34c5c2","includeProjectMetrics":true}'
const input = {
folderId: '624f6bb2-e06f-4353-8d6a-33d15f34c5c2',
includeProjectMetrics: true,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/folders_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/folders_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"folderId": "624f6bb2-e06f-4353-8d6a-33d15f34c5c2", "includeProjectMetrics": True},
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 szczegóły folderu, wraz z aktualnymi wskaźnikami projektów, jeśli o nie poproszono.{
"data": {
"folderId": "624f6bb2-e06f-4353-8d6a-33d15f34c5c2",
"folderName": "Product videos",
"projectIds": [
"project_123"
],
"dateCreated": 1792065600000,
"translationInstructions": "Keep product names unchanged.",
"projectMetrics": {
"projectsCount": 1,
"totalDurationSeconds": 120,
"translatedProjectsCount": 1,
"translationsInProgressProjectsCount": 0,
"awaitingProofreadingProjectsCount": 0
}
}
}
Pola wyniku
| Pole | Opis |
|---|---|
data.folderId | Identyfikator folderu. Używaj zwróconej wartości w kolejnych akcjach dotyczących folderu. |
data.folderName | Bieżąca nazwa folderu. |
data.projectIds | Identyfikatory dostępnych projektów przypisanych do tego folderu. |
data.dateCreated | Czas utworzenia folderu jako znacznik czasu Unix w milisekundach. |
data.translationInstructions | Instrukcje tłumaczenia zapisane w folderze; pusty ciąg oznacza ich brak. |
data.projectMetrics | Obecne, gdy zażądano metryk. |
data.projectMetrics.projectsCount | Liczba dostępnych projektów ujętych w projectIds. |
data.projectMetrics.totalDurationSeconds | Łączny czas trwania źródła w sekundach. |
data.projectMetrics.translatedProjectsCount | Projekty oznaczone jako przetłumaczone na wszystkie ich języki docelowe. |
data.projectMetrics.translationsInProgressProjectsCount | Projekty z tłumaczeniami w toku. |
data.projectMetrics.awaitingProofreadingProjectsCount | Projekty oczekujące na korektę. |
Uwagi do operacji
- includeProjectMetrics ma domyślną wartość false. Metryki są pomijane, chyba że o nie poproszono.
- Dla gości zespołu projectIds i żądane statystyki obejmują tylko projekty, które utworzyli przez API w aktywnym zespole. Zapisane wyniki i ponowienia stosują te same kontrole dostępu do projektów.
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 folderu lub wymaganego konta obszaru roboczego. |
| 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 | UNAUTHORIZED | Folder nie należy do aktywnego obszaru roboczego. |
| 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": ["folders:read"]
}
}
Czy ta strona była pomocna?

