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"
}
Mappen
Een map bijwerken
Wijzig de naam van een map of werk de vertaalinstructies bij die op projecten in de map worden toegepast.
POST
/
v1
/
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"
}
Wijzig de naam van een map of werk de vertaalinstructies bij die op projecten in de map worden toegepast.
Vereiste machtigingen:
POST https://api.voicecheap.ai/v1/actions/folders_update
Authenticatie en machtigingen
string
vereist
Stuur een VoiceCheap API-sleutel mee in deze header. Authorization: Bearer met dezelfde API-sleutel wordt ook ondersteund. OAuth-toegangstokens
worden alleen door MCP geaccepteerd, niet door dit REST-endpoint.
folders:write.
Een actief betaald abonnement is vereist. Machtigingen wijzigen geen teamrollen, eigendom van resources, mediategoed of abonnementslimieten.
Parameters
string
Optioneel op transportniveau: als de identificatie ontbreekt, voegt de server deze vóór de validatie toe. Geef zelf een stabiele UUID v4 op om veilig te kunnen herstellen als een antwoord verloren gaat.Formaat: “uuid”. Patroon:
^[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
vereist
Tekstwaarde.Minimale lengte: 1. Maximale lengte: 200. Patroon:
^[^/]+$.string
Tekstwaarde.Minimale lengte: 1. Maximale lengte: 60.
string
Tekstwaarde.Maximale lengte: 1000.
Volledig invoerschema
Volledig invoerschema
Het onderstaande JSON Schema behoudt de exacte veldnamen, geneste typen, standaardwaarden, grenzen en toegestane waarden die discovery beschikbaar stelt. Aanvullende regels tussen velden staan in de opmerkingen bij de bewerking.
{
"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
}
Idempotentie
Gebruik voor elke wijziging een UUID v4 in requestId of de HTTP-header Idempotency-Key. Gebruik na een netwerkfout dezelfde identificatie en identieke argumenten opnieuw. Als je beide opgeeft, moeten ze overeenkomen. Het opnieuw versturen van een opgeslagen aanvraag herhaalt de bewerking niet en verbruikt geen extra maandelijkse aanroep. Mislukte of onderbroken aanvragen worden niet automatisch opnieuw gestart. Elke wijziging kan HTTP 202 retourneren wanneer een nieuwe poging vaststelt dat dezelfde aanvraag nog loopt, ook wanneer de eerste uitvoering normaal synchroon is. Als de uitvoering is voltooid maar resultStored false is, retourneert een nieuwe poging HTTP 200 met de opgeslagen aanvraagstatus in plaats van het oorspronkelijke resultaat. Haal de uitvoer op via de geschiedenis-, resultaat- of downloadactie van het betreffende domein.Voorbeeldaanvragen
Vervang de voorbeeldidentificaties van resources en mediasleutels door waarden die voor je account zijn geretourneerd. Behoud dezelfde aanvraagidentificatie wanneer je dezelfde wijziging opnieuw probeert.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)
Antwoord
Een geslaagde eerste uitvoering retourneert HTTP 200 met het resultaat van de bewerking onder data. Een herhaalde aanvraag kan in plaats daarvan de opgeslagen aanvraagstatus retourneren. Het voorbeeld toont één ondersteund antwoord, niet alle optionele velden. Retourneert de map nadat de nieuwe naam of vertaalinstructies zijn opgeslagen.{
"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"
}
Resultaatvelden
| Veld | Beschrijving |
|---|---|
data.folderId | Mapidentificatie. Gebruik de geretourneerde waarde in volgende mapacties. |
data.folderName | Huidige mapnaam. |
data.projectIds | ID’s van toegankelijke projecten die aan deze map zijn toegewezen. |
data.dateCreated | Aanmaaktijdstip van de map als Unix-tijdstempel in milliseconden. |
data.translationInstructions | Vertaalinstructies die bij de map zijn opgeslagen; een lege tekenreeks betekent dat er geen zijn. |
Deze aanvraag herstellen en controleren
Gebruik dezelfde identificatie, ook nadat de verbinding is verbroken. Als resultStored false is, haal je de uitvoer op via de bijbehorende geschiedenis-, resultaat- of downloadactie. Start nooit een tweede generatie alleen om de voortgang te controleren.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."
}
}
}
Opmerkingen bij de bewerking
- Geef folderName, translationInstructions of beide op.
- Mapnamen bevatten 1–60 tekens; vertaalinstructies bevatten maximaal 1,000 tekens. Witruimte aan het begin en einde van instructies wordt vóór het opslaan verwijderd.
- Hernoemen werkt ook de mapnaam bij die op de toegewezen projecten wordt getoond. Instructies worden voor toekomstige vertaalbewerkingen uit de map gelezen.
- Voor teamgasten bevatten projectIds en aangevraagde statistieken alleen projecten die zij via de API in het actieve team hebben gemaakt. Opgeslagen resultaten en herhalingen passen dezelfde controles op projecttoegang toe.
- Een teamgast kan een map alleen hernoemen, de instructies wijzigen of de map verwijderen als alle toegewezen projecten toegankelijk zijn. Anders geeft de actie FOLDER_PROJECT_ACCESS_DENIED terug voordat wijzigingen worden aangebracht.
Verbruik
Elke geslaagde aanroep verbruikt één maandelijkse API/MCP-aanroep. Ook het mediategoed en de eigen generatielimieten van de bewerking zijn van toepassing.Fouten
| HTTP-status | Code | Betekenis of herstel |
|---|---|---|
| 400 | BAD_REQUEST | De map of het vereiste werkruimteaccount is niet gevonden. |
| 400 | CREDENTIAL_IN_QUERY | Inloggegevens zijn opgegeven in een queryparameter access_token of api_key. Stuur inloggegevens in headers. |
| 400 | IDEMPOTENCY_CONFLICT | De header Idempotency-Key en het bodyveld requestId moeten overeenkomen. |
| 400 | INVALID_REQUEST_ID | Geef een UUID v4 op als requestId of Idempotency-Key. |
| 400 | VALIDATION_ERROR | Het JSON-object bevat een niet-ondersteund veld, een ongeldige waarde of een ontbrekend verplicht argument. |
| 401 | API_KEY_EXPIRED | De API-sleutel is verlopen. |
| 401 | INVALID_API_KEY | Geef een geldige, niet-verlopen API-sleutel op. |
| 401 | INVALID_CREDENTIAL | De Authorization-header heeft een ongeldige indeling of is in strijd met x-api-key. |
| 401 | MISSING_CREDENTIAL | Er is geen bruikbaar authenticatiemiddel in de header opgegeven, of het overschreed 4096 tekens. |
| 401 | UNAUTHORIZED | De map is niet van de actieve werkruimte. |
| 401 | USER_NOT_FOUND | Het account dat bij de toegangsgegevens hoort, bestaat niet meer. |
| 403 | ACCOUNT_UNAVAILABLE | Het uitvoerende of factureringsaccount is niet beschikbaar of wordt verwijderd. |
| 403 | AMBIGUOUS_TEAM_API_KEY | De gebruiker van het authenticatiemiddel behoort tot meer dan één team, waardoor de factureringscontext onduidelijk is. |
| 403 | FOLDER_PROJECT_ACCESS_DENIED | Deze map bevat projecten die u niet kunt wijzigen. |
| 403 | INSUFFICIENT_SCOPE | Verleen alle vereiste machtigingen of kies andere toegangsgegevens. |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | De integratielimieten van het account konden niet worden geverifieerd. |
| 403 | SUBSCRIPTION_REQUIRED | Gebruik een actief betaald abonnement. |
| 403 | TEAM_MEMBERSHIP_INVALID | Het huidige teamlidmaatschap van het account komt niet overeen met de werkruimte van deze verbinding. Vernieuw het lidmaatschap en maak opnieuw verbinding. |
| 403 | TEAM_OWNER_NOT_FOUND | Het effectieve account van de teameigenaar kon niet worden gevonden. |
| 404 | ACCOUNT_NOT_FOUND | Het account of het account van de actieve werkruimte kon niet worden gevonden. |
| 409 | CONCURRENT_ACTION_LIMIT_REACHED | Voor dit account worden al 10 integratieacties uitgevoerd. Controleer een bestaande aanvraag voordat je een nieuwe start. |
| 409 | IDEMPOTENCY_CONFLICT | Gebruik een identificatie alleen opnieuw met dezelfde bewerking en argumenten. |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | Wacht tot de maandelijkse reset of wijzig je abonnement. |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | Wacht de tijd uit Retry-After af wanneer deze aanwezig is en vergroot de wachttijd tussen nieuwe pogingen. |
| 500 | INTERNAL_ERROR | Controleer de opgeslagen aanvraagstatus en de resourcegeschiedenis voordat je besluit een wijziging opnieuw te proberen. |
| 503 | ACTION_RESULT_UNAVAILABLE | De actie is uitgevoerd, maar het resultaat kon niet worden opgeslagen. Controleer de opgeslagen aanvraagstatus en resourcegeschiedenis voordat je een nieuwe generatie start. |
| 503 | SERVER_RESTARTING | De server wordt opnieuw gestart. Probeer het zo opnieuw en behoud bij een wijziging dezelfde aanvraagidentificatie. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["folders:write"]
}
}
Was deze pagina nuttig?

