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
}
}
}
Cartelle
Ottieni una cartella
Ottieni il nome, le istruzioni di traduzione, gli ID dei progetti e le metriche facoltative dei progetti di una cartella nella tua area di lavoro attiva.
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
}
}
}
Ottieni il nome, le istruzioni di traduzione, gli ID dei progetti e le metriche facoltative dei progetti di una cartella nella tua area di lavoro attiva.
Autorizzazioni richieste:
POST https://api.voicecheap.ai/v1/actions/folders_get
Autenticazione e autorizzazioni
string
obbligatorio
Invia una chiave API VoiceCheap in questa intestazione. È supportato anche Authorization: Bearer con la stessa chiave API. I token di accesso OAuth
sono accettati solo da MCP, non da questo endpoint REST.
folders:read.
È necessario un abbonamento a pagamento attivo. Le autorizzazioni non modificano i ruoli del team, la proprietà delle risorse, i crediti multimediali o i limiti del piano.
Parametri
string
obbligatorio
Valore testuale.Lunghezza minima: 1. Lunghezza massima: 200. Pattern:
^[^/]+$.boolean
Valore booleano.Valore predefinito: false.
Schema di input completo
Schema di input completo
Il JSON Schema seguente conserva i nomi esatti dei campi, i tipi annidati, i valori predefiniti, i limiti e i valori accettati esposti dalla discovery. Le ulteriori regole tra campi sono elencate nelle note sull’operazione.
{
"type": "object",
"properties": {
"folderId": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^/]+$"
},
"includeProjectMetrics": {
"default": false,
"type": "boolean"
}
},
"required": ["folderId"],
"additionalProperties": false
}
Esempi di richiesta
Sostituisci gli identificatori delle risorse e le chiavi multimediali di esempio con i valori restituiti per il tuo account. Mantieni stabile l’identificatore della richiesta quando ripeti la stessa modifica.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)
Risposta
Una prima esecuzione riuscita restituisce HTTP 200 con il risultato dell’operazione in data. Una ripetizione può invece restituire lo stato della richiesta salvata. L’esempio mostra una risposta supportata, non tutti i campi facoltativi. Restituisce i dettagli della cartella, con le metriche attuali dei progetti quando richieste.{
"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
}
}
}
Campi del risultato
| Campo | Descrizione |
|---|---|
data.folderId | Identificatore della cartella. Usa il valore restituito nelle successive azioni sulle cartelle. |
data.folderName | Nome attuale della cartella. |
data.projectIds | Identificatori dei progetti accessibili assegnati a questa cartella. |
data.dateCreated | Ora di creazione della cartella come timestamp Unix in millisecondi. |
data.translationInstructions | Istruzioni di traduzione salvate nella cartella; una stringa vuota indica che non ce ne sono. |
data.projectMetrics | Presente quando sono state richieste le metriche. |
data.projectMetrics.projectsCount | Numero di progetti accessibili inclusi in projectIds. |
data.projectMetrics.totalDurationSeconds | Durata complessiva della sorgente in secondi. |
data.projectMetrics.translatedProjectsCount | Progetti contrassegnati come tradotti in tutte le rispettive lingue di destinazione. |
data.projectMetrics.translationsInProgressProjectsCount | Progetti con traduzioni in corso. |
data.projectMetrics.awaitingProofreadingProjectsCount | Progetti in attesa di revisione. |
Note sull’operazione
- includeProjectMetrics ha come valore predefinito false. Le metriche vengono omesse se non richieste.
- Per gli ospiti del team, projectIds e le metriche richieste includono solo i progetti creati da loro tramite l’API nel team attivo. I risultati salvati e le ripetizioni applicano gli stessi controlli di accesso ai progetti.
Utilizzo
Ogni invocazione riuscita consuma una chiamata API/MCP mensile. Si applicano anche i crediti multimediali e le quote di generazione proprie dell’operazione.Errori
| Stato HTTP | Codice | Significato o risoluzione |
|---|---|---|
| 400 | BAD_REQUEST | La cartella o l’account richiesto per l’area di lavoro non è stato trovato. |
| 400 | CREDENTIAL_IN_QUERY | Le credenziali sono state fornite in un parametro di query access_token o api_key. Invia le credenziali negli header. |
| 400 | VALIDATION_ERROR | L’oggetto JSON contiene un campo non supportato, un valore non valido o un argomento obbligatorio mancante. |
| 401 | API_KEY_EXPIRED | La chiave API è scaduta. |
| 401 | INVALID_API_KEY | Fornisci una chiave API valida e non scaduta. |
| 401 | INVALID_CREDENTIAL | L’header Authorization non è valido oppure è in conflitto con x-api-key. |
| 401 | MISSING_CREDENTIAL | Non è stata fornita alcuna credenziale utilizzabile negli header, oppure la credenziale superava 4096 caratteri. |
| 401 | UNAUTHORIZED | La cartella non appartiene all’area di lavoro attiva. |
| 401 | USER_NOT_FOUND | L’account associato alla credenziale non esiste più. |
| 403 | AMBIGUOUS_TEAM_API_KEY | L’utente della credenziale appartiene a più di un team, quindi il contesto di fatturazione è ambiguo. |
| 403 | INSUFFICIENT_SCOPE | Concedi tutte le autorizzazioni richieste o scegli un’altra credenziale. |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | Impossibile verificare i limiti di integrazione dell’account. |
| 403 | SUBSCRIPTION_REQUIRED | Usa un abbonamento a pagamento attivo. |
| 403 | TEAM_MEMBERSHIP_INVALID | L’appartenenza attuale dell’account al team non corrisponde all’area di lavoro di questa connessione. Aggiorna l’appartenenza e riconnettiti. |
| 403 | TEAM_OWNER_NOT_FOUND | Non è stato possibile trovare l’account effettivo del proprietario del team. |
| 404 | ACCOUNT_NOT_FOUND | Non è stato possibile trovare l’account o l’account dell’area di lavoro attiva. |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | Attendi il ripristino mensile o cambia piano. |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | Rispetta Retry-After quando presente e applica attese crescenti tra i tentativi. |
| 500 | INTERNAL_ERROR | Controlla lo stato della richiesta salvata e la cronologia delle risorse prima di decidere se ripetere una modifica. |
| 503 | SERVER_RESTARTING | Il server si sta riavviando. Riprova tra poco e mantieni lo stesso identificatore della richiesta per una modifica. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["folders:read"]
}
}
Questa pagina è stata utile?