> ## 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.

# Obtener una carpeta

> Obtén el nombre, las instrucciones de traducción, los identificadores de proyectos y las métricas opcionales de los proyectos de una carpeta en tu espacio de trabajo activo.

Obtén el nombre, las instrucciones de traducción, los identificadores de proyectos y las métricas opcionales de los proyectos de una carpeta en tu espacio de trabajo activo.

```http theme={null}
POST https://api.voicecheap.ai/v1/actions/folders_get
```

## Autenticación y permisos

<ParamField header="x-api-key" type="string" required>
  Envía una clave de API de VoiceCheap en esta cabecera. También se admite Authorization: Bearer con la misma clave de API. Los tokens de acceso OAuth
  solo se aceptan en MCP, no en este endpoint REST.
</ParamField>

Permisos necesarios: `folders:read`.

Se requiere una suscripción de pago activa. Los permisos no cambian los roles del equipo, la propiedad de los recursos, los créditos multimedia ni los límites del plan.

## Parámetros

<ParamField body="folderId" type="string" required>
  Valor de texto.

  Longitud mínima: 1. Longitud máxima: 200. Patrón: `^[^/]+$`.
</ParamField>

<ParamField body="includeProjectMetrics" type="boolean">
  Valor booleano.

  Valor predeterminado: false.
</ParamField>

<Accordion title="Esquema completo de entrada">
  El JSON Schema siguiente conserva los nombres exactos de los campos, los tipos anidados, los valores predeterminados, los límites y los valores aceptados que expone el descubrimiento. Las reglas adicionales entre campos se indican en las notas de la operación.

  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "folderId": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200,
        "pattern": "^[^/]+$"
      },
      "includeProjectMetrics": {
        "default": false,
        "type": "boolean"
      }
    },
    "required": ["folderId"],
    "additionalProperties": false
  }
  ```
</Accordion>

## Ejemplos de solicitud

Sustituye los identificadores de recursos y las claves multimedia de los ejemplos por valores devueltos para tu cuenta. Mantén el identificador de solicitud al reintentar la misma modificación.

<RequestExample>
  ```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)
  ```
</RequestExample>

## Respuesta

Una primera ejecución correcta devuelve HTTP 200 con el resultado de la operación en data. Una repetición puede devolver el estado de la solicitud guardada en su lugar. El ejemplo muestra una respuesta admitida, no todos los campos opcionales.

Devuelve los detalles de la carpeta, con las métricas actuales de los proyectos cuando se solicitan.

<ResponseExample>
  ```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
      }
    }
  }
  ```
</ResponseExample>

## Campos del resultado

| Campo | Descripción |
| - | - |
| `data.folderId` | Identificador de carpeta. Usa el valor devuelto en las acciones de carpeta posteriores. |
| `data.folderName` | Nombre actual de la carpeta. |
| `data.projectIds` | Identificadores de los proyectos accesibles asignados a esta carpeta. |
| `data.dateCreated` | Hora de creación de la carpeta como marca de tiempo Unix en milisegundos. |
| `data.translationInstructions` | Instrucciones de traducción guardadas en la carpeta; una cadena vacía significa que no hay ninguna. |
| `data.projectMetrics` | Presente cuando se han solicitado métricas. |
| `data.projectMetrics.projectsCount` | Número de proyectos accesibles incluidos en projectIds. |
| `data.projectMetrics.totalDurationSeconds` | Duración combinada del origen en segundos. |
| `data.projectMetrics.translatedProjectsCount` | Proyectos marcados como traducidos a todos sus idiomas de destino. |
| `data.projectMetrics.translationsInProgressProjectsCount` | Proyectos con traducciones en curso. |
| `data.projectMetrics.awaitingProofreadingProjectsCount` | Proyectos pendientes de revisión. |

## Notas de la operación

* includeProjectMetrics tiene false como valor predeterminado. Las métricas se omiten a menos que se soliciten.
* Para los invitados del equipo, projectIds y las métricas solicitadas incluyen solo los proyectos que crearon mediante la API en el equipo activo. Los resultados guardados y las repeticiones aplican las mismas comprobaciones de acceso a proyectos.

## Uso

Cada invocación correcta consume una llamada mensual de API/MCP. También se aplican los créditos multimedia y las cuotas de generación propias de la operación.

## Errores

| Estado HTTP | Código | Significado o solución |
| - | - | - |
| 400 | `BAD_REQUEST` | No se ha encontrado la carpeta o la cuenta del espacio de trabajo requerida. |
| 400 | `CREDENTIAL_IN_QUERY` | Se han proporcionado credenciales en un parámetro de consulta access\_token o api\_key. Envía las credenciales en las cabeceras. |
| 400 | `VALIDATION_ERROR` | El objeto JSON contiene un campo no compatible, un valor no válido o un argumento obligatorio ausente. |
| 401 | `API_KEY_EXPIRED` | La clave API ha caducado. |
| 401 | `INVALID_API_KEY` | Proporciona una clave de API válida que no haya caducado. |
| 401 | `INVALID_CREDENTIAL` | La cabecera Authorization tiene un formato incorrecto o entra en conflicto con x-api-key. |
| 401 | `MISSING_CREDENTIAL` | No se proporcionó ninguna credencial de cabecera utilizable o superaba 4096 caracteres. |
| 401 | `UNAUTHORIZED` | La carpeta no pertenece al espacio de trabajo activo. |
| 401 | `USER_NOT_FOUND` | La cuenta de la credencial ya no existe. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | El usuario de la credencial pertenece a más de un equipo, por lo que el contexto de facturación es ambiguo. |
| 403 | `INSUFFICIENT_SCOPE` | Concede todos los permisos necesarios o elige otra credencial. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | No se han podido verificar los límites de integración de la cuenta. |
| 403 | `SUBSCRIPTION_REQUIRED` | Usa una suscripción de pago activa. |
| 403 | `TEAM_MEMBERSHIP_INVALID` | La membresía actual de la cuenta en el equipo no coincide con el espacio de trabajo de esta conexión. Actualiza la membresía y vuelve a conectar. |
| 403 | `TEAM_OWNER_NOT_FOUND` | No se pudo encontrar la cuenta del propietario efectivo del equipo. |
| 404 | `ACCOUNT_NOT_FOUND` | No se pudo encontrar la cuenta o la cuenta del espacio de trabajo activo. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Espera al restablecimiento mensual o cambia de plan. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Espera el tiempo indicado en Retry-After cuando esté presente y aplica esperas progresivas. |
| 500 | `INTERNAL_ERROR` | Comprueba el estado de la solicitud guardada y el historial del recurso antes de decidir si reintentas una modificación. |
| 503 | `SERVER_RESTARTING` | El servidor se está reiniciando. Reinténtalo en breve y conserva el mismo identificador de solicitud para una modificación. |

```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.