AI Glot websiteOpen AI Glot
REST APIAutenticação e escopos

Autenticação e escopos

Autentique requisições da API do AI Glot com chaves de workspace ou tokens OAuth, escolha os escopos mínimos e faça a rotação de credenciais sem expor segredos.

Envie uma chave de API de workspace ou um token de acesso OAuth como uma credencial Bearer:

Authorization header
Authorization: Bearer aig_live_••••••••

Nunca inclua uma credencial em uma query string. URLs são salvas em logs, no histórico do navegador e em cabeçalhos referrer.

Chaves de API de workspace

Um administrador cria chaves em Developer tools. O segredo completo é exibido apenas uma vez; o AI Glot armazena somente um hash protegido. Até 10 chaves podem estar ativas simultaneamente em um workspace.

Caixa de diálogo de criação de chave de API

Crie uma chave nomeada e escolha seus escopos

Use uma chave nomeada separada para cada integração.

Rotação de chaves

A lista de chaves disponibiliza a ação Rotate. Ela gera uma chave substituta com o mesmo nome, escopos e validade, revogando a original na mesma operação. A chave antiga para de funcionar imediatamente, é marcada como replaced (em vez de simplesmente revogada) e registra qual chave a sucedeu.

Isso é intencional: a rotação é feita porque um segredo pode estar comprometido, e uma chave que continuasse funcionando por mais uma hora continuaria funcionando para quem a interceptou. Para uma migração planejada e sem tempo de inatividade (zero downtime), crie uma segunda chave, migre a integração para ela, confirme que a chave antiga não recebe mais tráfego e, em seguida, revogue-a.

Tokens OAuth

A CLI e clientes MCP compatíveis podem usar OAuth 2.1. O OAuth é recomendado para usuários individuais porque a conexão registra quem a aprovou e respeita o teto de acesso desse membro. As chaves de API continuam sendo a opção ideal para CI e serviços de back-end.

Escopos

Estes escopos estão disponíveis atualmente:

EscopoPermissões
account:readIdentidade do workspace, plano, funcionalidades, limites e resumo de créditos
usage:readTotais de uso e intervalos de tempo
batches:readListar traduções, acompanhar o progresso e baixar resultados concluídos
batches:createCriar uma tradução, planejá-la e aprová-la. A aprovação consome créditos do workspace
batches:writeRenomear e arquivar traduções, além de cancelar tarefas em andamento. O cancelamento cobra pelo trabalho já concluído
glossaries:readListar e consultar glossários
glossaries:writeCriar, atualizar, substituir ou excluir glossários

A ausência de um escopo necessário retorna o erro 403 insufficient_scope.

Escopos reservados

Outros dois escopos podem ser concedidos hoje, mas nenhum endpoint os processa ainda. Eles aparecem na tela de consentimento do OAuth e no preset Full access do painel; por isso, estão documentados aqui em vez de ficarem ocultos: uma permissão solicitada para aprovação deve ser sempre localizável na documentação de referência.

EscopoPermitiráStatus
files:writeFazer upload de arquivos para o workspace em uma etapa separada, em vez de enviá-los na chamada de criaçãoIndisponível no momento
webhooks:writeCriar, editar e excluir webhooks que notificam seus sistemas quando o processamento for concluídoIndisponível no momento

Eles existem com antecedência para que uma credencial concedida agora continue funcionando no dia em que o recurso for lançado, sem exigir uma nova rodada de aprovação. Consulte o campo capabilities em GET /v1/account em vez dos escopos concedidos para determinar o que uma credencial realmente pode executar. Um escopo pode ser concedido antes mesmo que o endpoint correspondente esteja disponível.

Teto de acesso de membros

Os administradores do workspace podem limitar o acesso de desenvolvedor concedido aos membros. Um cliente OAuth recebe a interseção entre o que solicitou e o que o membro aprovador tem permissão para usar. Reconectar-se com uma solicitação mais ampla não permite contornar um limite de apenas leitura.

batches:create fica de fora do teto de acesso padrão para membros. Todos os outros escopos são concedidos por padrão à conexão de um membro; o escopo que consome créditos não é. Caso contrário, um agente em loop com uma credencial delegada poderia esgotar a cota de um mês inteiro antes que alguém percebesse, e créditos não podem ser estornados. Um administrador do workspace pode ampliar esse teto deliberadamente quando traduções iniciadas por agentes forem necessárias.

Use these docs with your AI tools

An AI agent can read this documentation directly. You do not need an account or an API key. Everything here is public and read-only.

Query these docs via MCP

Recommended

Add this server to Claude, Claude Code, Cursor, Mistral, or any tool that supports MCP. Your agent can then search AI Glot Docs documentation and read it in full, instead of answering from memory.

https://ai-glot.com/docs/mcp
  • searchFind the passages that answer a question.
  • fetchRead one page in full, as Markdown.
  • list_pagesSee every page in this documentation.

Query these docs over HTTP

The same tools also work as plain web requests. Use this for scripts, or for any tool that does not support MCP. There is one endpoint per tool. Arguments go in the query string, and the answer comes back as JSON.

https://ai-glot.com/docs/api/docs/search?query=custom+domain

Read the OpenAPI description. It is built from the same definitions as the tools, so it always matches what the endpoints do.

Read these docs as Markdown

Add .md to any page URL to get its Markdown source. You can also send the headerAccept: text/markdown to the page URL itself.

To read the whole documentation in one file, open llms-full.txt. For a short index of every page, open llms.txt.