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

# Atualizar configurações do projeto

> Renomeie um projeto ou altere instruções de tradução, estado de revisão, preferências de fala, áudio de fundo ou legendas. Apenas configurações explícitas do cliente podem ser alteradas.

Renomeie um projeto ou altere instruções de tradução, estado de revisão, preferências de fala, áudio de fundo ou legendas. Apenas configurações explícitas do cliente podem ser alteradas.

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

## 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:write`.

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

<ParamField body="requestId" type="string">
  Opcional na camada de transporte: o servidor insere um identificador antes da validação quando ele é omitido. Forneça seu próprio UUID v4 estável para recuperar com segurança uma resposta perdida.

  Formato: "uuid". Padrão: `^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$`.
</ParamField>

<ParamField body="changes" type="object" required>
  Objeto JSON. Consulte o esquema de entrada completo para ver os campos aninhados.
</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": "^[^/\\\\]+$"
      },
      "requestId": {
        "type": "string",
        "format": "uuid",
        "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
        "description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries."
      },
      "changes": {
        "type": "object",
        "properties": {
          "projectName": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "translationInstructions": {
            "type": "string",
            "maxLength": 1000
          },
          "isReadyForDubbing": {
            "type": "boolean"
          },
          "voiceCloning": {
            "type": "boolean"
          },
          "keepBackgroundMusic": {
            "type": "boolean"
          },
          "keepOriginalVoice": {
            "type": "boolean"
          },
          "originalVoiceVolume": {
            "type": "number",
            "minimum": 1,
            "maximum": 70
          },
          "activeSpeakerDetectionEnabled": {
            "type": "boolean"
          },
          "smartSync": {
            "type": "boolean"
          },
          "voiceIsolatorOption": {
            "type": "string",
            "enum": ["studio", "realistic"]
          },
          "voiceCloningSettings": {
            "type": "object",
            "properties": {
              "stability": {
                "type": "number",
                "minimum": 0,
                "maximum": 1
              },
              "similarity": {
                "type": "number",
                "minimum": 0,
                "maximum": 1
              }
            },
            "required": ["stability", "similarity"],
            "additionalProperties": false
          },
          "subtitles": {
            "type": "object",
            "properties": {
              "isEnable": {
                "type": "boolean"
              },
              "source": {
                "type": "string",
                "enum": ["original", "translated"]
              }
            },
            "required": ["isEnable", "source"],
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      }
    },
    "required": ["projectId", "changes"],
    "additionalProperties": false
  }
  ```
</Accordion>

## Idempotência

Use um UUID v4 em requestId ou no cabeçalho HTTP Idempotency-Key para cada alteração. Reutilize o mesmo identificador e argumentos idênticos após uma falha de rede. Se ambos forem fornecidos, devem ser iguais. Repetir uma requisição salva não repete a operação nem consome outra chamada mensal. Requisições com falha ou interrompidas não são reiniciadas automaticamente.

Qualquer alteração pode retornar HTTP 202 quando uma nova tentativa encontra a mesma requisição ainda em execução, mesmo que a primeira execução normalmente seja síncrona. Se a execução foi concluída, mas resultStored é false, uma nova tentativa retorna HTTP 200 com o estado salvo da requisição em vez do resultado original. Recupere a saída pela ação de histórico, resultado ou download do domínio correspondente.

## 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_update' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"projectId":"project_launch_2026","requestId":"41321bda-e243-4b6f-96a4-622cd047c991","changes":{"projectName":"Product launch — English","translationInstructions":"Keep product names unchanged.","keepBackgroundMusic":true,"subtitles":{"isEnable":true,"source":"translated"}}}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    projectId: 'project_launch_2026',
    requestId: '41321bda-e243-4b6f-96a4-622cd047c991',
    changes: {
      projectName: 'Product launch — English',
      translationInstructions: 'Keep product names unchanged.',
      keepBackgroundMusic: true,
      subtitles: {
        isEnable: true,
        source: 'translated',
      },
    },
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/projects_update', {
    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_update",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"projectId": "project_launch_2026", "requestId": "41321bda-e243-4b6f-96a4-622cd047c991", "changes": {"projectName": "Product launch — English", "translationInstructions": "Keep product names unchanged.", "keepBackgroundMusic": True, "subtitles": {"isEnable": True, "source": "translated"}}},
      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 atualizados do projeto após atualizar as configurações do cliente fornecidas explicitamente.

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "projectId": "project_launch_2026",
      "projectName": "Product launch — English",
      "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": "Keep product names unchanged.",
      "isReadyForDubbing": true,
      "settings": {
        "voiceCloning": true,
        "customVoice": false,
        "customVoiceId": "",
        "keepBackgroundMusic": true,
        "keepOriginalVoice": false,
        "originalVoiceVolume": 30,
        "activeSpeakerDetectionEnabled": false,
        "subtitles": {
          "isEnable": true,
          "source": "translated"
        },
        "smartSync": true,
        "voiceIsolatorOption": "studio",
        "voiceCloningSettings": {
          "stability": 0.5,
          "similarity": 0.75
        }
      }
    },
    "requestId": "41321bda-e243-4b6f-96a4-622cd047c991"
  }
  ```

  ```json HTTP 202 replay_running theme={null}
  {
    "data": {
      "requestId": "41321bda-e243-4b6f-96a4-622cd047c991",
      "operation": "projects_update",
      "createdAt": 1792144800000,
      "updatedAt": 1792144820000,
      "status": "running",
      "pollAfterSeconds": 5
    },
    "requestId": "41321bda-e243-4b6f-96a4-622cd047c991"
  }
  ```

  ```json HTTP 200 replay_completed_without_result theme={null}
  {
    "data": {
      "requestId": "41321bda-e243-4b6f-96a4-622cd047c991",
      "operation": "projects_update",
      "createdAt": 1792144800000,
      "updatedAt": 1792144820000,
      "status": "completed",
      "resultStored": false,
      "message": "The action completed. Retrieve its output from the corresponding history or resource action."
    },
    "requestId": "41321bda-e243-4b6f-96a4-622cd047c991"
  }
  ```
</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. |

## Recuperar e consultar esta requisição

Use o mesmo identificador mesmo após perder a conexão. Se resultStored for false, recupere a saída pela ação correspondente de histórico, resultado ou download. Nunca inicie uma segunda geração apenas para verificar o progresso.

```bash theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/action_request_get' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"requestId":"41321bda-e243-4b6f-96a4-622cd047c991","operation":"projects_update"}'
```

```json HTTP 200 theme={null}
{
  "data": {
    "requestId": "41321bda-e243-4b6f-96a4-622cd047c991",
    "operation": "projects_update",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "projectId": "project_launch_2026",
      "projectName": "Product launch — English",
      "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": "Keep product names unchanged.",
      "isReadyForDubbing": true,
      "settings": {
        "voiceCloning": true,
        "customVoice": false,
        "customVoiceId": "",
        "keepBackgroundMusic": true,
        "keepOriginalVoice": false,
        "originalVoiceVolume": 30,
        "activeSpeakerDetectionEnabled": false,
        "subtitles": {
          "isEnable": true,
          "source": "translated"
        },
        "smartSync": true,
        "voiceIsolatorOption": "studio",
        "voiceCloningSettings": {
          "stability": 0.5,
          "similarity": 0.75
        }
      }
    }
  }
}
```

## Notas da operação

* changes deve incluir pelo menos um campo compatível. Propriedades não listadas são rejeitadas. Campos omitidos permanecem inalterados.
* O objeto changes aceita projectName, translationInstructions, isReadyForDubbing, voiceCloning, keepBackgroundMusic, keepOriginalVoice, originalVoiceVolume, activeSpeakerDetectionEnabled, smartSync, voiceIsolatorOption, voiceCloningSettings e subtitles.
* originalVoiceVolume fica entre 1 e 70. voiceCloningSettings deve incluir stability e similarity entre 0 e 1; subtitles deve incluir isEnable e source.
* Atualiza as preferências e o estado de prontidão da revisão; por si só, não gera novamente mídia concluída anteriormente. O resultado usa a mesma projeção pública de projects\_get.
* 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 | `IDEMPOTENCY_CONFLICT` | O cabeçalho Idempotency-Key e o campo requestId do corpo devem ser iguais. |
| 400 | `INVALID_REQUEST_ID` | Forneça um requestId ou Idempotency-Key no formato UUID v4. |
| 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 | `ACCOUNT_UNAVAILABLE` | A conta que executa a ação ou a conta de cobrança está indisponível ou em processo de exclusão. |
| 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. |
| 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | Esta conta já tem 10 ações de integração em execução. Consulte uma requisição existente antes de iniciar outra. |
| 409 | `IDEMPOTENCY_CONFLICT` | Reutilize um identificador apenas com a mesma operação e os mesmos argumentos. |
| 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 | `ACTION_RESULT_UNAVAILABLE` | A ação foi executada, mas não foi possível salvar seu resultado. Inspecione o estado salvo da requisição e o histórico do recurso antes de iniciar uma nova geraçã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:write"]
  }
}
```


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