> ## 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. # Importar entradas do glossário > Importe linhas do glossário sem apagar as entradas existentes. Merge atualiza os termos correspondentes; ignore os preserva. Importe linhas do glossário sem apagar as entradas existentes. Merge atualiza os termos correspondentes; ignore os preserva. ```http theme={null} POST https://api.voicecheap.ai/v1/actions/glossary_import ``` ## Autenticação e permissões 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: `glossary: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 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}$`. Valor de texto. Comprimento mínimo: 2. Comprimento máximo: 64. Valor de texto. Valores aceitos: "merge", "replace", "ignore". Valor padrão: "merge". Lista de valores. Consulte o esquema de entrada completo para ver a estrutura dos itens. Mínimo de itens: 1. Máximo de itens: 500. 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": { "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." }, "sourceLanguage": { "type": "string", "minLength": 2, "maxLength": 64 }, "importMode": { "default": "merge", "type": "string", "enum": ["merge", "replace", "ignore"] }, "rows": { "minItems": 1, "maxItems": 500, "type": "array", "items": { "type": "object", "properties": { "rowNumber": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "sourceText": { "type": "string", "minLength": 1, "maxLength": 500 }, "targets": { "type": "object", "propertyNames": { "type": "string", "minLength": 2, "maxLength": 64 }, "additionalProperties": { "type": "object", "properties": { "text": { "type": "string", "maxLength": 2000 }, "mode": { "type": "string", "enum": ["translate", "keep"] }, "applicationMode": { "type": "string", "enum": ["smart", "strict"] } }, "required": ["text", "mode"], "additionalProperties": false } } }, "required": ["rowNumber", "sourceText", "targets"], "additionalProperties": false } } }, "required": ["sourceLanguage", "rows"], "additionalProperties": false } ``` ## 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. ```bash cURL theme={null} curl --request POST 'https://api.voicecheap.ai/v1/actions/glossary_import' \ --header "x-api-key: $VOICECHEAP_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"requestId":"58d5bb53-00d0-4692-bdaf-c6650ee87e30","sourceLanguage":"english","importMode":"merge","rows":[{"rowNumber":1,"sourceText":"Product","targets":{"french":{"text":"Produit","mode":"translate","applicationMode":"smart"}}}]}' ``` ```javascript JavaScript theme={null} const input = { requestId: '58d5bb53-00d0-4692-bdaf-c6650ee87e30', sourceLanguage: 'english', importMode: 'merge', rows: [ { rowNumber: 1, sourceText: 'Product', targets: { french: { text: 'Produit', mode: 'translate', applicationMode: 'smart', }, }, }, ], }; const response = await fetch('https://api.voicecheap.ai/v1/actions/glossary_import', { 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/glossary_import", headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]}, json={"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30", "sourceLanguage": "english", "importMode": "merge", "rows": [{"rowNumber": 1, "sourceText": "Product", "targets": {"french": {"text": "Produit", "mode": "translate", "applicationMode": "smart"}}}]}, 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 resumo da importação com a contagem de linhas importadas, a contagem resultante de entradas e as linhas inválidas ou ignoradas. ```json HTTP 200 theme={null} { "data": { "glossaryId": "user_123__english", "sourceLanguage": "english", "importedCount": 1, "entryCount": 1, "invalidRows": [], "importMode": "merge" }, "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30" } ``` ```json HTTP 202 replay_running theme={null} { "data": { "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30", "operation": "glossary_import", "createdAt": 1792144800000, "updatedAt": 1792144820000, "status": "running", "pollAfterSeconds": 5 }, "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30" } ``` ```json HTTP 200 replay_completed_without_result theme={null} { "data": { "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30", "operation": "glossary_import", "createdAt": 1792144800000, "updatedAt": 1792144820000, "status": "completed", "resultStored": false, "message": "The action completed. Retrieve its output from the corresponding history or resource action." }, "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30" } ``` ## Campos do resultado | Campo | Descrição | | - | - | | `data.glossaryId` | Identificador do glossário importado. | | `data.sourceLanguage` | Idioma de origem normalizado. | | `data.importedCount` | Número de linhas válidas passadas à operação de salvamento da importação. | | `data.entryCount` | Total de entradas salvas no glossário após a importação. | | `data.invalidRows` | Linhas inválidas ou ignoradas com rowNumber, sourceText opcional e reason. | | `data.invalidRows[].rowNumber` | Identificador da linha no payload enviado. | | `data.invalidRows[].sourceText` | Termo de origem, quando disponível. | | `data.invalidRows[].reason` | Motivo pelo qual a linha foi inválida ou ignorada. | | `data.importMode` | Modo solicitado, com merge como padrão. | ## 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":"58d5bb53-00d0-4692-bdaf-c6650ee87e30","operation":"glossary_import"}' ``` ```json HTTP 200 theme={null} { "data": { "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30", "operation": "glossary_import", "status": "completed", "createdAt": 1792144800000, "updatedAt": 1792144820000, "resultStored": true, "result": { "glossaryId": "user_123__english", "sourceLanguage": "english", "importedCount": 1, "entryCount": 1, "invalidRows": [], "importMode": "merge" } } } ``` ## Notas da operação * Aceita 1–500 linhas estruturadas com 1–200 idiomas de destino por linha. Cada objeto de destino requer text e mode. * merge é o padrão. ignore ignora os termos de origem já presentes e os informa em invalidRows. * A implementação atual aceita replace, mas salva pela mesma operação de mesclagem; ela não remove entradas omitidas do payload. Não dependa de replace para limpar um glossário existente. * Termos de origem duplicados e idiomas de destino desconhecidos são informados como linhas inválidas. A requisição falha se não restarem linhas válidas. * Quando um destino de linha omite applicationMode, a importação atualmente atribui strict a esse destino. Forneça smart ou strict explicitamente quando o modo desejado for relevante. ## 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` | Nenhuma linha válida do glossário restou após a validaçã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 | `GLOSSARY_IMPORT_UNKNOWN_LANGUAGE` | O idioma de origem da importação não é compatível. | | 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` | 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 | `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` | Somente o proprietário do espaço de trabalho pago pode editar seu glossário. Os membros da equipe têm apenas acesso de leitura. | | 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. | | 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": ["glossary:write"] } } ``` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.