> ## 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 configurações da conta > Consulte vocabulário salvo, instruções de tradução, predefinições de voz e idioma, modelos favoritos e preferências pessoais da interface. Consulte vocabulário salvo, instruções de tradução, predefinições de voz e idioma, modelos favoritos e preferências pessoais da interface. ```http theme={null} POST https://api.voicecheap.ai/v1/actions/settings_get ``` ## 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: `settings: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 Envie um objeto JSON vazio. Esta ação não possui campos de entrada. 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": {}, "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/settings_get' \ --header "x-api-key: $VOICECHEAP_API_KEY" \ --header 'Content-Type: application/json' \ --data '{}' ``` ```javascript JavaScript theme={null} const input = {}; const response = await fetch('https://api.voicecheap.ai/v1/actions/settings_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/settings_get", headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]}, json={}, 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 as preferências pessoais do solicitante e o vocabulário compartilhado e as instruções de tradução do proprietário do espaço de trabalho ativo. ```json HTTP 200 theme={null} { "data": { "companyName": "Studio", "brandVocabulary": [ "VoiceCheap" ], "customTranslationInstructions": "Keep product names unchanged.", "canEditSharedSettings": true, "favoriteTemplates": { "dynamicSubtitles": null, "voiceIds": [] }, "targetLanguagePresets": [ { "id": "european_languages", "name": "European languages", "languages": [ "french", "german" ] } ], "socialMediaStatsPresets": [], "textToSpeechBrandPresets": [], "defaultVoiceCloningSettings": { "stability": 0.5, "similarity": 0.75 }, "isSoundNotificationsEnabled": true, "isVoiceCloningSettingsTipDismissed": false } } ``` ## Campos do resultado | Campo | Descrição | | - | - | | `data.companyName` | Nome da empresa pessoal, ou null. | | `data.brandVocabulary` | Vocabulário compartilhado do proprietário do espaço de trabalho; um array vazio significa que não há nenhum. | | `data.customTranslationInstructions` | Instruções de tradução compartilhadas da conta; uma string vazia significa que não há instruções. | | `data.canEditSharedSettings` | Indica se o solicitante pode alterar o vocabulário compartilhado e as instruções de tradução. | | `data.favoriteTemplates` | Favoritos salvos de legendas e vozes, ou null. | | `data.favoriteTemplates.dynamicSubtitles` | Nome do modelo favorito de legendas dinâmicas, ou null. | | `data.favoriteTemplates.voiceIds` | Identificadores de vozes favoritas. | | `data.targetLanguagePresets` | Predefinições pessoais de idioma salvas. | | `data.targetLanguagePresets[].id` | Identificador da predefinição. | | `data.targetLanguagePresets[].name` | Nome de exibição da predefinição. | | `data.targetLanguagePresets[].languages` | Idiomas salvos nessa predefinição. | | `data.socialMediaStatsPresets` | Seleções pessoais de canais salvas. | | `data.socialMediaStatsPresets[].channelIds` | Identificadores de canais salvos nessa predefinição. | | `data.textToSpeechBrandPresets` | Predefinições pessoais salvas de interpretação de conversão de texto em fala. | | `data.textToSpeechBrandPresets[].voice` | Identificador salvo de seleção de voz. | | `data.textToSpeechBrandPresets[].instructionPreset` | Nome da predefinição de interpretação salva. | | `data.textToSpeechBrandPresets[].instructions` | Instruções de interpretação salvas. | | `data.textToSpeechBrandPresets[].speed` | Multiplicador salvo da velocidade de fala. | | `data.defaultVoiceCloningSettings` | Valores padrão de stability e similarity ou null. | | `data.isSoundNotificationsEnabled` | Preferência pessoal de notificação sonora. | | `data.isVoiceCloningSettingsTipDismissed` | Indica se o chamador dispensou a dica de configurações de voz. | ## Notas da operação * Quando a conta é membro de uma equipe, as configurações compartilhadas vêm do proprietário da equipe, enquanto as preferências de interface continuam pessoais. ## 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` | 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": ["settings:read"] } } ``` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.