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 rotacione credenciais sem expor segredos.

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

Cabeçalho de Autorização
Authorization: Bearer aig_live_••••••••

Nunca coloque uma credencial em uma query string. URLs são copiadas em logs, histórico do navegador e cabeçalhos de referenciador (referrer).

Chaves de API de Workspace

Um administrador cria as chaves em Ferramentas do desenvolvedor. O segredo completo é exibido apenas uma vez; o AI Glot armazena apenas um hash protegido. Até 10 chaves podem estar ativas em um workspace.

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.

Rotacionando uma chave

A lista de chaves oferece a ação Rotacionar (Rotate). Ela emite uma 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 (substituída) em vez de apenas revogada, e registra qual chave a sucedeu.

Isso é deliberado: você rotaciona porque um segredo pode ter sido comprometido, e uma chave que continue funcionando por mais uma hora continuará funcionando para quem a roubou. Para uma transição planejada e sem tempo de inatividade, crie uma segunda chave, migre a integração para ela, confirme que a chave antiga não recebe mais tráfego e, então, revogue-a.

Tokens OAuth

O CLI e clientes MCP compatíveis podem usar OAuth 2.1. O OAuth é recomendado para pessoas, pois a conexão registra quem a aprovou e respeita o teto de acesso desse membro. Chaves de API continuam sendo a escolha certa para CI e serviços de backend.

Escopos

Estes escopos estão disponíveis atualmente:

EscopoPermite
account:readIdentidade do workspace, plano, capacidades, limites e resumo de créditos
usage:readTotais de uso e intervalos de tempo
batches:readListar traduções, inspecionar progresso e baixar resultados concluídos
batches:writeRenomear e arquivar traduções. O mesmo escopo também cobre a interrupção de uma tradução em andamento, funcionalidade ainda não disponível
glossaries:readListar e recuperar glossários
glossaries:writeCriar, atualizar, substituir ou excluir glossários

Um escopo ausente retorna 403 insufficient_scope.

Escopos reservados

Mais três escopos podem ser concedidos hoje, mas nenhum endpoint os reconhece ainda. Eles aparecem na tela de consentimento do OAuth e no preset de Acesso total do dashboard, por isso estão documentados aqui em vez de ocultos — qualquer permissão que você seja solicitado a aprovar deve ser sempre encontrável na referência.

EscopoPermitiráStatus
batches:createIniciar uma nova tradução e aprovar uma após a etapa de revisão. Ambas consomem créditos do workspaceIndisponível no momento
files:writeFazer upload de arquivos para o workspace para que possam ser traduzidosIndisponível no momento
webhooks:writeCriar, editar e excluir os webhooks que notificam seus sistemas quando o trabalho terminaIndisponível no momento

Eles existem precocemente para que uma credencial concedida agora continue funcionando no dia em que a funcionalidade for lançada, sem a necessidade de uma nova rodada de aprovação. Até lá, GET /v1/account reporta capabilities.batch_creation: false e capabilities.webhooks: false, e as chamadas para esses endpoints ficam indisponíveis, independentemente do escopo. Leia as flags de capacidade (capabilities) em vez dos escopos concedidos para decidir o que uma credencial pode realmente fazer.

Teto do membro

Administradores do workspace podem limitar o acesso de desenvolvedores para membros. Um cliente OAuth recebe a interseção entre o que solicitou e o que o membro aprovador pode usar. Reconectar com uma solicitação mais ampla não pode ignorar um teto de apenas leitura.

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.