> ## 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 el ciclo de uso de un proyecto

> Obtén los cargos de minutos de traducción y sincronización labial, los reembolsos y los eventos del ciclo de vida de un proyecto de tu espacio de trabajo.

Obtén los cargos de minutos de traducción y sincronización labial, los reembolsos y los eventos del ciclo de vida de un proyecto de tu espacio de trabajo.

```http theme={null}
POST https://api.voicecheap.ai/v1/actions/usage_project_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: `usage: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="projectId" type="string" required>
  Valor de texto.

  Longitud mínima: 1. Longitud máxima: 200. Patrón: `^[^/]+$`.
</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": {
      "projectId": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200,
        "pattern": "^[^/]+$"
      }
    },
    "required": ["projectId"],
    "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/usage_project_get' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"projectId":"project_123"}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    projectId: 'project_123',
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/usage_project_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/usage_project_get",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"projectId": "project_123"},
      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 totales de minutos de todo el proyecto y los eventos del ciclo de vida de sus ejecuciones de traducción en el espacio de trabajo activo.

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "kind": "project",
      "isHistoricalDerived": false,
      "summary": {
        "title": "Product launch",
        "sourceLanguage": "English",
        "totals": {
          "translationBaseMinutes": 2,
          "lipSyncExtraMinutes": 0,
          "lipSyncProExtraMinutes": 0,
          "lipSyncPro2ExtraMinutes": 0,
          "totalChargedMinutes": 2,
          "refundedMinutes": 0,
          "netUsedMinutes": 2
        }
      },
      "events": [
        {
          "id": "project_123-project-created",
          "type": "project_created",
          "timestamp": 1792065540000,
          "tone": "neutral"
        },
        {
          "id": "version_123-translation-launched",
          "type": "translation_launched",
          "timestamp": 1792065600000,
          "tone": "neutral",
          "minuteDelta": 2,
          "relatedRunLabel": "French"
        },
        {
          "id": "version_123-translation-completed",
          "type": "translation_completed",
          "timestamp": 1792065720000,
          "tone": "success",
          "isDerived": false,
          "relatedRunLabel": "French"
        }
      ]
    }
  }
  ```
</ResponseExample>

## Campos del resultado

| Campo | Descripción |
| - | - |
| `data.kind` | translation o project. |
| `data.isHistoricalDerived` | Indica si uno o más detalles de uso se obtuvieron a partir de datos históricos. |
| `data.summary.title` | Nombre visible del proyecto. |
| `data.summary.sourceLanguage` | Etiqueta formateada del idioma de origen cuando está disponible. |
| `data.summary.targetLanguage` | Idioma de destino para un ciclo de vida de traducción; se omite en un ciclo de vida de proyecto. |
| `data.summary.translationStatus` | Estado de traducción de un ciclo de vida de traducción; se omite en un ciclo de vida de proyecto. |
| `data.summary.lipSyncStatus` | Estado de sincronización labial del ciclo de vida de una traducción; se omite en el ciclo de vida de un proyecto. |
| `data.summary.totals.translationBaseMinutes` | Minutos de traducción base cobrados en las filas coincidentes. |
| `data.summary.totals.lipSyncExtraMinutes` | Minutos adicionales de sincronización labial Standard cobrados. |
| `data.summary.totals.lipSyncProExtraMinutes` | Minutos adicionales de sincronización labial Pro cobrados. |
| `data.summary.totals.lipSyncPro2ExtraMinutes` | Minutos adicionales de sincronización labial Pro 2 cobrados. |
| `data.summary.totals.totalChargedMinutes` | Total de minutos cobrados antes de los reembolsos. |
| `data.summary.totals.refundedMinutes` | Minutos reembolsados. |
| `data.summary.totals.netUsedMinutes` | Minutos cobrados menos minutos reembolsados. |
| `data.events` | Eventos del ciclo de vida ordenados por marca de tiempo; los eventos sin marca de tiempo aparecen después de los que la tienen. |
| `data.events[].id` | Identificador estable del evento para el paso del ciclo de vida indicado. |
| `data.events[].type` | Tipo de evento, como project\_created, translation\_launched, translation\_completed o lip\_sync\_refunded. |
| `data.events[].timestamp` | Marca de tiempo opcional del evento en milisegundos. |
| `data.events[].tone` | neutral, success, warning o danger. |
| `data.events[].relatedRunLabel` | Idioma de destino y etiqueta de ejecución opcionales para los eventos del ciclo de vida del proyecto. |
| `data.events[].minuteDelta` | Minutos cobrados opcionales como número positivo o minutos reembolsados como número negativo. |
| `data.events[].isDerived` | Indicador opcional de un evento reconstruido a partir de datos históricos. |

## Notas de la operación

* El proyecto debe tener al menos una fila de uso en el espacio de trabajo activo; un proyecto sin filas de uso devuelve un error.
* El resumen abarca todo el proyecto y omite un único targetLanguage, translationStatus y lipSyncStatus. Los eventos individuales incluyen una etiqueta de idioma de destino o ejecución cuando corresponde.
* Los eventos omiten los mensajes de error de procesamiento sin procesar y las etiquetas visibles de los eventos.

## 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 el proyecto o no tiene filas de uso de traducción en el espacio de trabajo activo. |
| 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 | `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": ["usage:read"]
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.