> ## 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 o ciclo de uso de uma tradução

> Consulte eventos do ciclo de vida de cobrança, reembolso, tradução e sincronização labial de uma versão traduzida no seu espaço de trabalho.

Consulte eventos do ciclo de vida de cobrança, reembolso, tradução e sincronização labial de uma versão traduzida no seu espaço de trabalho.

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

## Autenticação e permissões

**x-api-key** `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.

Permissões necessárias: `usage: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

**translatedVersionId** `string` *required*

Valor de texto.

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

> [accordion] 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": {
>     "translatedVersionId": {
>       "type": "string",
>       "minLength": 1,
>       "maxLength": 200,
>       "pattern": "^[^/]+$"
>     }
>   },
>   "required": ["translatedVersionId"],
>   "additionalProperties": false
> }
> ```

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

```bash cURL theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/usage_translation_get' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"translatedVersionId":"version_123"}'
```

```javascript JavaScript theme={null}
const input = {
  translatedVersionId: 'version_123',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/usage_translation_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_translation_get",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"translatedVersionId": "version_123"},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
```

## 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 o ciclo de vida público de cobrança e processamento de uma versão traduzida no espaço de trabalho ativo.

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

## Campos do resultado

| Campo | Descrição |
| - | - |
| `data.kind` | translation ou project. |
| `data.isHistoricalDerived` | Indica se um ou mais detalhes de uso foram derivados de dados históricos. |
| `data.summary.title` | Nome de exibição do projeto. |
| `data.summary.sourceLanguage` | Rótulo formatado do idioma de origem, quando disponível. |
| `data.summary.targetLanguage` | Idioma de destino de um ciclo de vida de tradução; omitido em um ciclo de vida de projeto. |
| `data.summary.translationStatus` | Status da tradução para um ciclo de vida de tradução; omitido em um ciclo de vida de projeto. |
| `data.summary.lipSyncStatus` | Status de sincronização labial para um ciclo de vida de tradução; omitido de um ciclo de vida de projeto. |
| `data.summary.totals.translationBaseMinutes` | Minutos de tradução base cobrados nas linhas correspondentes. |
| `data.summary.totals.lipSyncExtraMinutes` | Minutos adicionais de sincronização labial Standard cobrados. |
| `data.summary.totals.lipSyncProExtraMinutes` | Minutos adicionais de sincronização labial Pro cobrados. |
| `data.summary.totals.lipSyncPro2ExtraMinutes` | Minutos adicionais de sincronização labial Pro 2 cobrados. |
| `data.summary.totals.totalChargedMinutes` | Total de minutos cobrados antes dos reembolsos. |
| `data.summary.totals.refundedMinutes` | Minutos reembolsados. |
| `data.summary.totals.netUsedMinutes` | Minutos cobrados menos minutos reembolsados. |
| `data.events` | Eventos do ciclo de vida em ordem de marcação de tempo; eventos sem marcação de tempo vêm após os eventos com marcação. |
| `data.events[].id` | Identificador estável do evento para a etapa relatada do ciclo de vida. |
| `data.events[].type` | Tipo de evento como project\_created, translation\_launched, translation\_completed ou lip\_sync\_refunded. |
| `data.events[].timestamp` | Marcação de tempo opcional do evento em milissegundos. |
| `data.events[].tone` | neutral, success, warning ou danger. |
| `data.events[].relatedRunLabel` | Idioma de destino e rótulo de execução opcionais para eventos do ciclo de vida do projeto. |
| `data.events[].minuteDelta` | Minutos cobrados opcionais como número positivo ou minutos reembolsados como número negativo. |
| `data.events[].isDerived` | Indicador opcional de um evento reconstruído a partir de dados históricos. |

## Notas da operação

* A versão deve pertencer ao espaço de trabalho ativo.
* A resposta omite mensagens brutas de erros de processamento e rótulos de exibição de eventos. Use o tipo de evento para interpretar o ciclo de vida.
* Os registros de data e hora e os indicadores de derivação podem estar ausentes em eventos históricos.

## 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 | `BAD_REQUEST` | Não foi possível encontrar a versão traduzida no espaço de trabalho ativo. |
| 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` | O objeto JSON contém um campo não compatível, um valor inválido ou um argumento obrigatório ausente. |
| 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 | `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_MEMBERSHIP_INVALID` | O vínculo atual da conta com a equipe não corresponde ao espaço de trabalho desta conexão. Atualize o vínculo de membro e reconecte. |
| 403 | `TEAM_OWNER_NOT_FOUND` | Não foi possível encontrar a conta efetiva do proprietário da equipe. |
| 404 | `ACCOUNT_NOT_FOUND` | Não foi possível encontrar a conta ou a conta do espaço de trabalho ativo. |
| 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": ["usage:read"]
  }
}
```


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