> ## 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 un proyecto

> Obtén los detalles del proyecto, los ajustes editables, la revisión de segmentos, las URL de salida y las versiones de traducción.

Obtén los detalles del proyecto, los ajustes editables, la revisión de segmentos, las URL de salida y las versiones de traducción.

```http theme={null}
POST https://api.voicecheap.ai/v1/actions/projects_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: `projects: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/projects_get' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"projectId":"project_launch_2026"}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    projectId: 'project_launch_2026',
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/projects_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/projects_get",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"projectId": "project_launch_2026"},
      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 públicos del proyecto, los ajustes del cliente, la revisión actual de la estructura de origen y todas las versiones de salida traducidas.

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "projectId": "project_launch_2026",
      "projectName": "Product launch",
      "status": "success",
      "workflow": "translation",
      "originalVideoUrl": "https://media.example.com/launch/original.mp4",
      "originalLanguage": "fr",
      "targetLanguages": [
        "english"
      ],
      "duration": 75,
      "createdAt": 1792152000000,
      "progress": {
        "step": "done",
        "transcriptionProgress": 100,
        "transcriptionStatus": "success"
      },
      "translations": [
        {
          "workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
          "translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c",
          "targetLanguage": "english",
          "status": "completed",
          "currentStep": "done",
          "progress": 100,
          "createdAt": 1792152060000,
          "completedAt": 1792152300000,
          "translatedVideoUrl": "https://media.example.com/launch/english.mp4",
          "translatedAudioUrl": "https://media.example.com/launch/english.mp3",
          "settings": {
            "voiceCloning": true,
            "uploadType": "video",
            "keepBackgroundMusic": true,
            "keepOriginalVoice": false,
            "originalVoiceVolume": 30,
            "subtitles": {
              "isEnable": false,
              "source": "translated"
            },
            "smartSync": true,
            "dubbingMode": "translate",
            "voiceIsolatorOption": "studio"
          }
        }
      ],
      "segmentStructureRevision": 3,
      "numberOfSpeakers": 1,
      "translationInstructions": "",
      "isReadyForDubbing": true,
      "settings": {
        "voiceCloning": true,
        "customVoice": false,
        "customVoiceId": "",
        "keepBackgroundMusic": true,
        "keepOriginalVoice": false,
        "originalVoiceVolume": 30,
        "activeSpeakerDetectionEnabled": false,
        "subtitles": {
          "isEnable": false,
          "source": "translated"
        },
        "smartSync": true,
        "voiceIsolatorOption": "studio",
        "voiceCloningSettings": {
          "stability": 0.5,
          "similarity": 0.75
        }
      }
    }
  }
  ```
</ResponseExample>

## Campos del resultado

| Campo | Descripción |
| - | - |
| `data.projectId` | Identificador de un proyecto accesible. |
| `data.projectName` | Nombre del proyecto visible para el cliente. |
| `data.status` | Resumen del proyecto: processing, success o failed. |
| `data.workflow` | transcription para proyectos de solo transcripción; translation para proyectos de doblaje. |
| `data.originalVideoUrl` | URL del archivo multimedia original almacenado, incluidos los proyectos de audio; cadena vacía cuando no existe. |
| `data.originalLanguage` | Idioma de origen detectado o seleccionado; unknown si no está disponible. |
| `data.targetLanguages` | Array de nombres de idiomas de destino. |
| `data.duration` | Duración del contenido multimedia original en segundos. |
| `data.createdAt` | Momento de creación del proyecto en milisegundos Unix. |
| `data.progress` | Paso de transcripción público, transcriptionProgress opcional y transcriptionStatus. |
| `data.translations` | Todas las versiones traducidas de todos los trabajos de idioma, ordenadas de la más reciente a la más antigua según el createdAt normalizado. |
| `data.segmentStructureRevision` | Revisión actual de la estructura de segmentos de origen, con valor predeterminado 0. Pasa este valor como expectedSegmentStructureRevision a segments\_delete o segments\_merge. |
| `data.numberOfSpeakers` | Número guardado de hablantes del origen, cuando está presente. |
| `data.translationInstructions` | Instrucciones actuales de traducción del proyecto; es una cadena vacía cuando no hay ninguna almacenada. |
| `data.isReadyForDubbing` | Solo es true cuando el proyecto almacenado está marcado como listo para doblaje. |
| `data.settings` | Ajustes opcionales del cliente seleccionados de los ajustes de doblaje del proyecto o de los ajustes antiguos. Solo se devuelven los campos almacenados; se omiten los valores opcionales ausentes. |
| `data.settings.voiceCloning` | Preferencia opcional de clonación de voz del proyecto. |
| `data.settings.customVoice` | Preferencia opcional de voz personalizada. |
| `data.settings.customVoiceId` | Identificador opcional de voz personalizada. |
| `data.settings.keepBackgroundMusic` | Preferencia opcional de audio de fondo. |
| `data.settings.keepOriginalVoice` | Preferencia opcional de voz original. |
| `data.settings.originalVoiceVolume` | Volumen opcional de la voz original. |
| `data.settings.activeSpeakerDetectionEnabled` | Preferencia opcional de detección del hablante activo. |
| `data.settings.subtitles` | Preferencia opcional de subtítulos \{isEnable,source}. |
| `data.settings.smartSync` | Preferencia opcional de SmartSync. |
| `data.settings.voiceIsolatorOption` | Preferencia opcional de aislamiento de voz studio o realistic. |
| `data.settings.voiceCloningSettings` | Preferencias opcionales de clonación de voz \{stability,similarity}. |
| `data.error` | \{code,message} público opcional para un fallo de procesamiento a nivel de proyecto. |
| `data.translations[].workId` | Identificador del trabajo de idioma que contiene esta versión. |
| `data.translations[].translatedVersionId` | Identificador de una versión concreta del resultado de doblaje. |
| `data.translations[].targetLanguage` | Idioma de destino de la versión, con el de su trabajo de idioma como alternativa. |
| `data.translations[].status` | Estado de la versión almacenada: not-started, in-progress, completed o failed. |
| `data.translations[].currentStep` | Paso opcional del proceso de doblaje; progress es un valor numérico opcional de progreso. |
| `data.translations[].progress` | Valor opcional del progreso de doblaje. |
| `data.translations[].createdAt` | Hora de creación normalizada a milisegundos Unix; usa la hora de creación del trabajo de idioma como alternativa. |
| `data.translations[].completedAt` | Hora opcional de finalización en milisegundos Unix. |
| `data.translations[].failedAt` | Hora opcional del fallo en milisegundos Unix. |
| `data.translations[].timedOutAt` | Hora opcional de expiración del tiempo de espera en milisegundos Unix. |
| `data.translations[].translatedVideoUrl` | URL almacenada del vídeo traducido, o una cadena vacía cuando no está disponible. |
| `data.translations[].translatedAudioUrl` | URL almacenada del audio traducido, o una cadena vacía cuando no está disponible. |
| `data.translations[].error` | \{code,message} opcional cuando la versión ha fallado. |
| `data.translations[].settings` | Ajustes públicos de la versión: voiceCloning, uploadType, keepBackgroundMusic, keepOriginalVoice, originalVoiceVolume, subtitles, smartSync, dubbingMode, voiceIsolatorOption y los campos opcionales translationQualityMode, cutBecauseFreeUser, originalDurationSeconds, cutDurationSeconds, voiceCloningSettings. |
| `data.translations[].settings.dubbingMode` | translate o dub-only. SmartSync es false para las versiones dub-only. |
| `data.translations[].lipSync` | \{latest,history} opcional; cada entrada tiene jobId, status, videoUrl, errorMessage, type, createdAt y los campos opcionales requestedAt, retryRequestedAt, completedAt, failedAt, timedOutAt, activeSpeakerDetectionEnabled, isRetried. Los tiempos de sincronización labial se almacenan como cadenas ISO. |
| `data.translations[].dynamicSubtitles` | Objeto opcional con used, inProgress, magicZooms, magicBrolls, magicBrollsPercentage, videoUrl, errorMessage y los campos opcionales removeSilencePace, removeBadTakes, templateName, requestedAt, rerunCount. requestedAt se expresa en milisegundos Unix. |
| `data.translations[].publicationAttempts` | Array opcional de intentos públicos de publicación: id, status, origin y, opcionalmente, scheduledAt, processingStartedAt, publishedAt, failedAt, privacyStatus, url, videoId, errorMessage. |
| `data.translations[].publishedVideos` | Array opcional con type, videoId, privacyStatus y los campos opcionales url, datePublished, origin, scheduledAt, plannedPublicationId. |

## Notas de la operación

* Esta acción no devuelve el texto de la transcripción ni los documentos de segmentos sin procesar. Usa transcripts\_get para obtener el contenido de la transcripción y translations\_list para los metadatos de los trabajos de idioma.
* Los campos anidados opcionales que falten se omiten del JSON serializado. Las URL de salida son cadenas vacías hasta que la salida correspondiente esté disponible.
* El estado del proyecto resume el flujo de trabajo y la versión traducida más reciente; consulta las entradas individuales de translations\[] al gestionar varios idiomas.
* El campo error describe un fallo de procesamiento almacenado; recuperar correctamente un proyecto fallido sigue devolviendo un resultado normal.
* Los fallos guardados devuelven códigos de error de VoiceCheap y mensajes fijos. Use el código y el estado actual del recurso para decidir cómo recuperarse del error.

## 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 | `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` | Corrige la entrada según el esquema. Los valores no válidos o incoherentes se rechazan antes de la ejecución. |
| 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 | `FORBIDDEN` | El actor autenticado no puede acceder a este proyecto. |
| 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_OWNER_NOT_FOUND` | No se pudo encontrar la cuenta del propietario efectivo del equipo. |
| 404 | `PROJECT_NOT_FOUND` | El proyecto no existe en la cuenta accesible. |
| 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": ["projects:read"]
  }
}
```


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