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

# Consultar um projeto

> Consulte detalhes do projeto, configurações editáveis, revisão dos segmentos, URLs de saída e versões de tradução.

Consulte detalhes do projeto, configurações editáveis, revisão dos segmentos, URLs de saída e versões de tradução.

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

## Autenticação e permissões

<ParamField header="x-api-key" type="string" required>
  Envie uma chave de API VoiceCheap neste cabeçalho. Authorization: Bearer com a mesma chave de API também é aceito. Tokens de acesso OAuth são
  aceitos apenas pelo MCP, não por este endpoint REST.
</ParamField>

Permissões necessárias: `projects:read`.

É necessária uma assinatura paga ativa. As permissões não alteram funções na equipe, propriedade dos recursos, créditos de mídia ou limites do plano.

## Parâmetros

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

  Comprimento mínimo: 1. Comprimento máximo: 200. Padrão: `^[^/\\]+$`.
</ParamField>

<Accordion title="Esquema de entrada completo">
  O JSON Schema abaixo preserva os nomes exatos dos campos, tipos aninhados, valores padrão, limites e valores aceitos expostos pela descoberta. Regras adicionais entre campos são listadas nas notas da operação.

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

## Exemplos de requisição

Substitua os identificadores de recursos e as chaves de mídia dos exemplos pelos valores retornados para sua conta. Mantenha o identificador da requisição ao tentar novamente a mesma alteração.

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

## Resposta

Uma primeira execução bem-sucedida retorna HTTP 200 com o resultado da operação em data. Uma repetição pode retornar o estado salvo da requisição. O exemplo mostra uma resposta aceita, não todos os campos opcionais.

Retorna os detalhes públicos do projeto, as configurações do cliente, a revisão atual da estrutura da fonte e todas as versões de saída traduzidas.

<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 do resultado

| Campo | Descrição |
| - | - |
| `data.projectId` | Identificador de projeto acessível. |
| `data.projectName` | Nome do projeto visível ao cliente. |
| `data.status` | Resumo do projeto: processing, success ou failed. |
| `data.workflow` | transcription para projetos somente de transcrição; translation para projetos de dublagem. |
| `data.originalVideoUrl` | URL original da mídia armazenada, incluindo projetos de áudio; string vazia quando ausente. |
| `data.originalLanguage` | Idioma de origem detectado ou selecionado; unknown quando indisponível. |
| `data.targetLanguages` | Array de nomes de idiomas de destino. |
| `data.duration` | Duração da mídia original em segundos. |
| `data.createdAt` | Horário de criação do projeto em milissegundos Unix. |
| `data.progress` | Etapa pública de transcrição, transcriptionProgress opcional e transcriptionStatus. |
| `data.translations` | Todas as versões traduzidas de todos os trabalhos de idioma, ordenadas das mais recentes para as mais antigas pelo createdAt normalizado. |
| `data.segmentStructureRevision` | Revisão atual da estrutura dos segmentos de origem, com valor padrão 0. Passe este valor como expectedSegmentStructureRevision para segments\_delete ou segments\_merge. |
| `data.numberOfSpeakers` | Número armazenado de locutores da origem, quando presente. |
| `data.translationInstructions` | Instruções atuais de tradução do projeto; string vazia quando nenhuma está armazenada. |
| `data.isReadyForDubbing` | true apenas quando o projeto armazenado está marcado como pronto para dublagem. |
| `data.settings` | Configurações opcionais do cliente selecionadas das configurações de dublagem do projeto ou das configurações legadas. Apenas campos armazenados são retornados; valores opcionais ausentes são omitidos. |
| `data.settings.voiceCloning` | Preferência opcional de clonagem de voz do projeto. |
| `data.settings.customVoice` | Preferência opcional de voz personalizada. |
| `data.settings.customVoiceId` | Identificador opcional de voz personalizada. |
| `data.settings.keepBackgroundMusic` | Preferência opcional de áudio de fundo. |
| `data.settings.keepOriginalVoice` | Preferência opcional de fala original. |
| `data.settings.originalVoiceVolume` | Volume opcional da fala original. |
| `data.settings.activeSpeakerDetectionEnabled` | Preferência opcional de detecção do locutor ativo. |
| `data.settings.subtitles` | Preferência opcional de legendas \{isEnable,source}. |
| `data.settings.smartSync` | Preferência opcional de SmartSync. |
| `data.settings.voiceIsolatorOption` | Preferência opcional de isolamento de voz studio ou realistic. |
| `data.settings.voiceCloningSettings` | Preferências opcionais de clonagem de voz \{stability,similarity}. |
| `data.error` | \{code,message} público opcional para uma falha de processamento no nível do projeto. |
| `data.translations[].workId` | Identificador do trabalho de idioma que contém esta versão. |
| `data.translations[].translatedVersionId` | Identificador de uma versão específica da saída de dublagem. |
| `data.translations[].targetLanguage` | Idioma de destino da versão, usando como alternativa o idioma do seu trabalho de idioma. |
| `data.translations[].status` | Estado da versão armazenada: not-started, in-progress, completed ou failed. |
| `data.translations[].currentStep` | Etapa opcional do fluxo de dublagem; progress é um valor numérico opcional de progresso. |
| `data.translations[].progress` | Valor opcional de progresso da dublagem. |
| `data.translations[].createdAt` | Horário de criação normalizado em milissegundos Unix; usa como alternativa o horário de criação do trabalho de idioma. |
| `data.translations[].completedAt` | Horário opcional de conclusão em milissegundos Unix. |
| `data.translations[].failedAt` | Horário opcional da falha em milissegundos Unix. |
| `data.translations[].timedOutAt` | Horário opcional de esgotamento do prazo em milissegundos Unix. |
| `data.translations[].translatedVideoUrl` | URL armazenada do vídeo traduzido ou uma string vazia quando indisponível. |
| `data.translations[].translatedAudioUrl` | URL armazenada do áudio traduzido ou uma string vazia quando indisponível. |
| `data.translations[].error` | \{code,message} opcional quando a versão falhou. |
| `data.translations[].settings` | Configurações públicas da versão: voiceCloning, uploadType, keepBackgroundMusic, keepOriginalVoice, originalVoiceVolume, subtitles, smartSync, dubbingMode, voiceIsolatorOption e, opcionalmente, translationQualityMode, cutBecauseFreeUser, originalDurationSeconds, cutDurationSeconds, voiceCloningSettings. |
| `data.translations[].settings.dubbingMode` | translate ou dub-only. SmartSync é false para versões dub-only. |
| `data.translations[].lipSync` | \{latest,history} opcional; cada entrada tem jobId, status, videoUrl, errorMessage, type, createdAt e, opcionalmente, requestedAt, retryRequestedAt, completedAt, failedAt, timedOutAt, activeSpeakerDetectionEnabled, isRetried. Os horários de sincronização labial são armazenados como strings ISO. |
| `data.translations[].dynamicSubtitles` | Objeto opcional com used, inProgress, magicZooms, magicBrolls, magicBrollsPercentage, videoUrl, errorMessage e, opcionalmente, removeSilencePace, removeBadTakes, templateName, requestedAt, rerunCount. requestedAt está em milissegundos Unix. |
| `data.translations[].publicationAttempts` | Array opcional de tentativas públicas de publicação: id, status, origin, além dos opcionais scheduledAt, processingStartedAt, publishedAt, failedAt, privacyStatus, url, videoId, errorMessage. |
| `data.translations[].publishedVideos` | Array opcional com type, videoId, privacyStatus e, opcionalmente, url, datePublished, origin, scheduledAt, plannedPublicationId. |

## Notas da operação

* Esta ação não retorna texto de transcrição nem documentos brutos de segmentos. Use transcripts\_get para o conteúdo da transcrição e translations\_list para os metadados dos trabalhos de idioma.
* Campos aninhados opcionais ausentes são omitidos do JSON serializado. As URLs de saída são strings vazias até a saída correspondente estar disponível.
* O status do projeto resume o fluxo de trabalho e a versão traduzida mais recente; inspecione cada entrada de translations\[] ao gerenciar vários idiomas.
* O campo error descreve uma falha de processamento armazenada; um projeto com falha recuperado com sucesso ainda retorna um resultado normal.
* As falhas salvas retornam códigos de erro da VoiceCheap e mensagens fixas. Use o código e o estado atual do recurso para decidir como se recuperar.

## Uso

Cada chamada bem-sucedida consome uma chamada mensal da API/MCP. Os créditos de mídia e as cotas de geração da própria operação também se aplicam.

## Erros

| Status HTTP | Código | Significado ou recuperação |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | Foram fornecidas credenciais em um parâmetro de consulta access\_token ou api\_key. Envie as credenciais nos cabeçalhos. |
| 400 | `VALIDATION_ERROR` | Corrija a entrada usando o esquema. Valores inválidos ou inconsistentes são rejeitados antes da execução. |
| 401 | `API_KEY_EXPIRED` | A chave de API expirou. |
| 401 | `INVALID_API_KEY` | Forneça uma chave de API válida e dentro do prazo de validade. |
| 401 | `INVALID_CREDENTIAL` | O cabeçalho Authorization está malformado ou entra em conflito com x-api-key. |
| 401 | `MISSING_CREDENTIAL` | Nenhuma credencial utilizável foi fornecida no cabeçalho, ou ela excedeu 4096 caracteres. |
| 401 | `USER_NOT_FOUND` | A conta da credencial não existe mais. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | O usuário da credencial pertence a mais de uma equipe, portanto o contexto de cobrança é ambíguo. |
| 403 | `FORBIDDEN` | O autor autenticado da ação não pode acessar este projeto. |
| 403 | `INSUFFICIENT_SCOPE` | Conceda todas as permissões necessárias ou escolha outra credencial. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | Não foi possível verificar os limites de integração da conta. |
| 403 | `SUBSCRIPTION_REQUIRED` | Use uma assinatura paga ativa. |
| 403 | `TEAM_OWNER_NOT_FOUND` | Não foi possível encontrar a conta efetiva do proprietário da equipe. |
| 404 | `PROJECT_NOT_FOUND` | O projeto não existe na conta acessível. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Aguarde a renovação do limite mensal ou mude de plano. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Aguarde o prazo de Retry-After, quando presente, e aumente progressivamente o intervalo entre as tentativas. |
| 500 | `INTERNAL_ERROR` | Verifique o estado da requisição salva e o histórico do recurso antes de decidir repetir uma alteração. |
| 503 | `SERVER_RESTARTING` | O servidor está reiniciando. Tente novamente em breve e mantenha o mesmo identificador de requisição para uma alteração. |

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