Aggiorna una cartella

curl --request POST 'https://api.voicecheap.ai/v1/actions/folders_update' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"requestId":"58d5bb53-00d0-4692-bdaf-c6650ee87e30","folderId":"624f6bb2-e06f-4353-8d6a-33d15f34c5c2","folderName":"Product videos","translationInstructions":"Keep product names unchanged."}'

const input = {
  requestId: '58d5bb53-00d0-4692-bdaf-c6650ee87e30',
  folderId: '624f6bb2-e06f-4353-8d6a-33d15f34c5c2',
  folderName: 'Product videos',
  translationInstructions: 'Keep product names unchanged.',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/folders_update', {
  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_update",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30", "folderId": "624f6bb2-e06f-4353-8d6a-33d15f34c5c2", "folderName": "Product videos", "translationInstructions": "Keep product names unchanged."},
    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."
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

{
  "data": {
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
    "operation": "folders_update",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "running",
    "pollAfterSeconds": 5
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

{
  "data": {
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
    "operation": "folders_update",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "completed",
    "resultStored": false,
    "message": "The action completed. Retrieve its output from the corresponding history or resource action."
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

POST

actions

folders_update

curl --request POST 'https://api.voicecheap.ai/v1/actions/folders_update' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"requestId":"58d5bb53-00d0-4692-bdaf-c6650ee87e30","folderId":"624f6bb2-e06f-4353-8d6a-33d15f34c5c2","folderName":"Product videos","translationInstructions":"Keep product names unchanged."}'

const input = {
  requestId: '58d5bb53-00d0-4692-bdaf-c6650ee87e30',
  folderId: '624f6bb2-e06f-4353-8d6a-33d15f34c5c2',
  folderName: 'Product videos',
  translationInstructions: 'Keep product names unchanged.',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/folders_update', {
  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_update",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30", "folderId": "624f6bb2-e06f-4353-8d6a-33d15f34c5c2", "folderName": "Product videos", "translationInstructions": "Keep product names unchanged."},
    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."
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

{
  "data": {
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
    "operation": "folders_update",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "running",
    "pollAfterSeconds": 5
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

{
  "data": {
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
    "operation": "folders_update",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "completed",
    "resultStored": false,
    "message": "The action completed. Retrieve its output from the corresponding history or resource action."
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

Rinomina una cartella o aggiorna le istruzioni di traduzione applicate ai progetti che contiene.

POST https://api.voicecheap.ai/v1/actions/folders_update

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.

Autorizzazioni richieste: folders:write. È 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

Facoltativo al livello di trasporto: se omesso, il server inserisce un identificatore prima della validazione. Fornisci un tuo UUID v4 stabile per recuperare in sicurezza una risposta persa.Formato: “uuid”. Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$.

string

obbligatorio

Valore testuale.Lunghezza minima: 1. Lunghezza massima: 200. Pattern: ^[^/]+$.

string

Valore testuale.Lunghezza minima: 1. Lunghezza massima: 60.

string

Valore testuale.Lunghezza massima: 1000.

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": {
    "requestId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
      "description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries."
    },
    "folderId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "pattern": "^[^/]+$"
    },
    "folderName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 60
    },
    "translationInstructions": {
      "type": "string",
      "maxLength": 1000
    }
  },
  "required": ["folderId"],
  "additionalProperties": false
}

Idempotenza

Usa un UUID v4 in requestId o nell’intestazione HTTP Idempotency-Key per ogni modifica. Riutilizza lo stesso identificatore e argomenti identici dopo un errore di rete. Se vengono forniti entrambi, devono coincidere. Ripetere una richiesta salvata non ripete l’operazione e non consuma un’altra chiamata mensile. Le richieste non riuscite o interrotte non vengono riavviate automaticamente. Ogni modifica può restituire HTTP 202 quando un nuovo tentativo trova la stessa richiesta ancora in esecuzione, anche se la prima esecuzione è normalmente sincrona. Se l’esecuzione è completata ma resultStored è false, un nuovo tentativo restituisce HTTP 200 con lo stato della richiesta salvata anziché il risultato originale. Recupera l’output tramite l’azione di cronologia, risultato o download del relativo dominio.

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_update' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"requestId":"58d5bb53-00d0-4692-bdaf-c6650ee87e30","folderId":"624f6bb2-e06f-4353-8d6a-33d15f34c5c2","folderName":"Product videos","translationInstructions":"Keep product names unchanged."}'

const input = {
  requestId: '58d5bb53-00d0-4692-bdaf-c6650ee87e30',
  folderId: '624f6bb2-e06f-4353-8d6a-33d15f34c5c2',
  folderName: 'Product videos',
  translationInstructions: 'Keep product names unchanged.',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/folders_update', {
  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_update",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30", "folderId": "624f6bb2-e06f-4353-8d6a-33d15f34c5c2", "folderName": "Product videos", "translationInstructions": "Keep product names unchanged."},
    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 la cartella dopo il salvataggio del nuovo nome o delle nuove istruzioni di traduzione.

{
  "data": {
    "folderId": "624f6bb2-e06f-4353-8d6a-33d15f34c5c2",
    "folderName": "Product videos",
    "projectIds": [
      "project_123"
    ],
    "dateCreated": 1792065600000,
    "translationInstructions": "Keep product names unchanged."
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

{
  "data": {
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
    "operation": "folders_update",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "running",
    "pollAfterSeconds": 5
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

{
  "data": {
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
    "operation": "folders_update",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "completed",
    "resultStored": false,
    "message": "The action completed. Retrieve its output from the corresponding history or resource action."
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

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.

Recupera e monitora questa richiesta

Usa lo stesso identificatore anche dopo una connessione persa. Se resultStored è false, recupera l’output tramite la corrispondente azione di cronologia, risultato o download. Non avviare mai una seconda generazione solo per verificarne l’avanzamento.

curl --request POST 'https://api.voicecheap.ai/v1/actions/action_request_get' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"requestId":"58d5bb53-00d0-4692-bdaf-c6650ee87e30","operation":"folders_update"}'

HTTP 200

{
  "data": {
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
    "operation": "folders_update",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "folderId": "624f6bb2-e06f-4353-8d6a-33d15f34c5c2",
      "folderName": "Product videos",
      "projectIds": ["project_123"],
      "dateCreated": 1792065600000,
      "translationInstructions": "Keep product names unchanged."
    }
  }
}

Note sull’operazione

Fornisci folderName, translationInstructions o entrambi.
I nomi delle cartelle contengono 1–60 caratteri; le istruzioni di traduzione contengono al massimo 1,000 caratteri. Gli spazi iniziali e finali delle istruzioni vengono rimossi prima del salvataggio.
La ridenominazione aggiorna anche il nome della cartella visualizzato nei progetti assegnati. Le istruzioni vengono lette dalla cartella per i futuri lavori di traduzione.
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.
Un ospite del team può rinominare una cartella, modificarne le istruzioni o eliminarla solo se tutti i progetti assegnati gli sono accessibili. In caso contrario, l’azione restituisce FOLDER_PROJECT_ACCESS_DENIED prima di apportare modifiche.

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	`IDEMPOTENCY_CONFLICT`	L’intestazione Idempotency-Key e il campo requestId del corpo devono coincidere.
400	`INVALID_REQUEST_ID`	Fornisci requestId o Idempotency-Key come UUID v4.
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	`ACCOUNT_UNAVAILABLE`	L’account che esegue l’azione o quello di fatturazione non è disponibile o è in fase di eliminazione.
403	`AMBIGUOUS_TEAM_API_KEY`	L’utente della credenziale appartiene a più di un team, quindi il contesto di fatturazione è ambiguo.
403	`FOLDER_PROJECT_ACCESS_DENIED`	Questa cartella contiene progetti che non può modificare.
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.
409	`CONCURRENT_ACTION_LIMIT_REACHED`	Questo account ha già 10 azioni di integrazione in esecuzione. Interroga una richiesta esistente prima di avviarne un’altra.
409	`IDEMPOTENCY_CONFLICT`	Riutilizza un identificatore solo con la stessa operazione e gli stessi argomenti.
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	`ACTION_RESULT_UNAVAILABLE`	L’azione è stata eseguita ma non è stato possibile salvarne il risultato. Esamina lo stato della richiesta salvata e la cronologia delle risorse prima di avviare una nuova generazione.
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:write"]
  }
}

Panoramica

Discovery

Account

Utilizzo e attività

Impostazioni e notifiche

Team

Progetti

Traduzione e doppiaggio

Trascrizioni e modifica

Sintesi vocale

Voci per la sintesi vocale

Voci per il doppiaggio

Trascrizione

Sottotitoli e didascalie

Immagini

Miniature

Cartelle

Glossario

Webhook

Pubblicazione

Stato delle richieste

OAuth e protocollo MCP

Autenticazione e autorizzazioni

Parametri

Idempotenza

Esempi di richiesta

Risposta

Campi del risultato

Recupera e monitora questa richiesta

Note sull’operazione

Utilizzo

Errori

​Autenticazione e autorizzazioni

​Parametri

​Idempotenza

​Esempi di richiesta

​Risposta

​Campi del risultato

​Recupera e monitora questa richiesta

​Note sull’operazione

​Utilizzo

​Errori

Autenticazione e autorizzazioni

Parametri

Idempotenza

Esempi di richiesta

Risposta

Campi del risultato

Recupera e monitora questa richiesta

Note sull’operazione

Utilizzo

Errori