> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.voicecheap.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # Een map ophalen > Haal de naam, vertaalinstructies, project-ID’s en optionele projectstatistieken van een map in je actieve werkruimte op. Haal de naam, vertaalinstructies, project-ID’s en optionele projectstatistieken van een map in je actieve werkruimte op. ```http theme={null} POST https://api.voicecheap.ai/v1/actions/folders_get ``` ## Authenticatie en machtigingen 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. Vereiste machtigingen: `folders:read`. Een actief betaald abonnement is vereist. Machtigingen wijzigen geen teamrollen, eigendom van resources, mediategoed of abonnementslimieten. ## Parameters Tekstwaarde. Minimale lengte: 1. Maximale lengte: 200. Patroon: `^[^/]+$`. Booleaanse waarde. Standaardwaarde: false. 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. ```json theme={null} { "type": "object", "properties": { "folderId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[^/]+$" }, "includeProjectMetrics": { "default": false, "type": "boolean" } }, "required": ["folderId"], "additionalProperties": false } ``` ## 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. ```bash cURL theme={null} 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}' ``` ```javascript JavaScript theme={null} 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); ``` ```python Python theme={null} 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) ``` ## 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 mapgegevens, met actuele projectstatistieken wanneer daarom is gevraagd. ```json HTTP 200 theme={null} { "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 } } } ``` ## 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. | | `data.projectMetrics` | Aanwezig wanneer metrieken zijn aangevraagd. | | `data.projectMetrics.projectsCount` | Aantal toegankelijke projecten in projectIds. | | `data.projectMetrics.totalDurationSeconds` | Gecombineerde bronduur in seconden. | | `data.projectMetrics.translatedProjectsCount` | Projecten die in al hun doeltalen als vertaald zijn gemarkeerd. | | `data.projectMetrics.translationsInProgressProjectsCount` | Projecten met vertalingen die worden verwerkt. | | `data.projectMetrics.awaitingProofreadingProjectsCount` | Projecten die wachten op proeflezen. | ## Opmerkingen bij de bewerking * includeProjectMetrics is standaard false. Metrieken worden weggelaten, tenzij ze worden aangevraagd. * 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. ## 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 | `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 | `AMBIGUOUS_TEAM_API_KEY` | De gebruiker van het authenticatiemiddel behoort tot meer dan één team, waardoor de factureringscontext onduidelijk is. | | 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. | | 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 | `SERVER_RESTARTING` | De server wordt opnieuw gestart. Probeer het zo opnieuw en behoud bij een wijziging dezelfde aanvraagidentificatie. | ```json theme={null} { "code": "INSUFFICIENT_SCOPE", "message": "This credential does not permit the requested action.", "status": 403, "details": { "requiredScopes": ["folders:read"] } } ``` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.