Para agentes de IA: guia passo a passo de configuração — /docs/agents.md, índice da documentação — /llms.txt.

Para agentes de IA

Como delegar a integração a um agente de IA: prompt pronto para qualquer ferramenta. Abaixo — endereços de documentação legíveis por máquina e uma skill que o agente instala com um único comando.

Prompt para o agente#

Envie este prompt ao seu agente de IA. Ele vai configurar a ferramenta conforme as instruções abaixo e vai pedir a chave para você.

Prompt para o agente
Conecte o sua ferramenta ao JoinGonka Gateway — a API compatível com OpenAI e Anthropic da rede Gonka — seguindo as instruções em https://gate.joingonka.ai/docs/agents.md. A chave eu mesmo vou fornecer: não a salve em arquivos do repositório nem altere variáveis de ambiente globais. No final, teste a conexão com uma requisição curta e informe o resultado.

Abaixo estão as instruções. O agente as recebe em Markdown no endereço /docs/agents.md.

Regras#

  • A chave de API é criada por uma pessoa no painel do usuário em gate.joingonka.ai. Não cadastre uma conta nem crie chaves por conta própria: peça a chave ao usuário.
  • Mantenha a chave na variável de ambiente JOINGONKA_API_KEY da sua sessão de terminal. Não a grave em arquivos sob git, não faça commit dela nem a mostre no relatório.
  • Não altere as variáveis globais OPENAI_* e ANTHROPIC_* — nem no perfil do shell nem no sistema: outras ferramentas do usuário as leem. A chave e o endereço são gravados na configuração da própria ferramenta — é o que o instalador faz.

Fatos#

  • URL base para clientes da OpenAI API: https://gate.joingonka.ai/v1
  • URL base para clientes da Anthropic API, sem /v1: https://gate.joingonka.ai
  • A chave é enviada no cabeçalho Authorization: Bearer jg-… ou x-api-key: jg-…
  • A chave para consultar os modelos começa com jg-; a chave de gerenciamento gm- não dá acesso aos modelos.
  • Modelo recomendado: MiniMaxAI/MiniMax-M2.7
  • Lista de modelos disponíveis: GET https://gate.joingonka.ai/v1/models
  • Por chave, até 120 requisições por minuto; acima do limite, resposta 429 com o cabeçalho Retry-After. Os limites e timeouts estão na resposta GET /v1/capabilities, campo limits.

Configuração#

Encontre a ferramenta do usuário na tabela no fim da seção. Se houver o valor --tool, configure com o instalador; se não houver, faça manualmente seguindo o guia.

Com o instalador#

Um único comando sem perguntas: a chave vem da variável de ambiente e o modelo é passado por flag. O instalador grava a configuração da ferramenta, salva uma cópia da anterior e testa a conexão com uma requisição ao gateway.

Bash
JOINGONKA_API_KEY=<key> npx -y @joingonka/setup --tool <id> --model MiniMaxAI/MiniMax-M2.7 --non-interactive
FlagO que faz
--tool <id>Qual ferramenta configurar — valor da tabela de ferramentas.
--model <id>Identificador do modelo: o recomendado é MiniMaxAI/MiniMax-M2.7; todos os disponíveis, GET /v1/models.
--non-interactiveSem perguntas: a chave é obtida de JOINGONKA_API_KEY.
--scope localConfiguração no projeto atual, e não no diretório home. Somente para o Claude Code; o arquivo de configuração é adicionado ao .gitignore.
--no-verifyNão testar a conexão depois de gravar a configuração.
Código de saídaO que significa
0Pronto: configuração gravada e requisição de teste bem-sucedida. Se não foi possível testar por rede ou saldo, o instalador imprime um aviso, mas também sai com código 0 — avise o usuário.
1A configuração falhou; o motivo está na saída: por exemplo, um valor desconhecido de --tool, JOINGONKA_API_KEY não definida ou uma chave que não começa com jg-.
2A configuração foi gravada, mas a requisição de teste falhou: verifique a chave e o identificador do modelo.

Se a ferramenta estava aberta, reinicie-a: a configuração é lida na inicialização.

Manualmente#

Para uma ferramenta sem instalador, abra o guia dela (link na tabela abaixo) e defina três valores:

  • endereço base — https://gate.joingonka.ai/v1 para clientes da OpenAI API ou https://gate.joingonka.ai para clientes da Anthropic API;
  • chave — no campo de chave de API nas configurações da ferramenta;
  • modelo — MiniMaxAI/MiniMax-M2.7 ou outro de GET /v1/models.

Ferramentas e guias#

Ferramenta--tool
Cursorcursor
Claude Codeclaude-code
OpenClawopenclaw
OpenCodeopencode
Continuecontinue
Clinecline
Aideraider
LangChain—
n8n—
Open WebUI—
LibreChat—
Hermeshermes
Kilo Codekilo
Roo Coderoo
LlamaIndex—
PydanticAI—
Vercel AI SDK—
TanStack AI—
ZCodezcode
JetBrainsjetbrains
Copilot BYOKcopilot-byok
Zedzed
Pipi
Codex CLIcodex
DeepSeek Harness—
MiniMax Codeminimax-code
Warp—
Trae—
Cherry Studio—
omp (Oh My Pi)omp
OpenHands—
Qwen Codeqwen-code
Goosegoose
Crushcrush
Zoo Codezoo
Kimi Codekimi-code
Factory Droiddroid
MiMo Codemimo-code

Verificação#

Teste da chave — consulta de saldo: não gasta tokens e a chave vem de JOINGONKA_API_KEY:

cURL
curl -s https://gate.joingonka.ai/api/balance \
  -H "Authorization: Bearer $JOINGONKA_API_KEY"

Teste do endereço, da chave e do modelo — uma requisição curta ao modelo:

cURL
curl -s https://gate.joingonka.ai/v1/chat/completions \
  -H "Authorization: Bearer $JOINGONKA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model": "MiniMaxAI/MiniMax-M2.7", "messages": [{"role": "user", "content": "Say OK"}], "max_tokens": 32}'

Uma resposta 200 com texto do modelo significa que a conexão funciona. O instalador faz esse teste sozinho: depois dele, basta o código de saída 0.

Se algo der errado#

O erro chega no campo error do corpo da resposta — com o tipo e o texto do motivo.

RespostaO que fazer
401 authentication_errorChave não aceita. Verifique se ela foi copiada por inteiro e enviada em Authorization: Bearer ou x-api-key; quem cria uma chave nova é o usuário.
402 insufficient_fundsNão há saldo. Avise o usuário: o saldo é recarregado no painel do usuário.
402 child_key_limit_exceededO limite da chave secundária foi esgotado. É preciso outra chave ou um limite maior — isso quem decide é o dono da chave.
403 forbiddenEssa é a chave de gerenciamento gm-: ela não dá acesso aos modelos. É preciso uma chave jg-.
400 invalid_request_errorErro na requisição. Se o modelo não for encontrado, o texto do erro traz a lista de identificadores disponíveis — pegue de lá ou de GET /v1/models.
404 model_not_foundEsse modelo não está disponível agora — escolha outro de GET /v1/models.
429Requisições demais ou rede ocupada. Espere a quantidade de segundos indicada no cabeçalho Retry-After e tente de novo.
503 model_unavailableA rede não está atendendo o modelo agora. Troque para o modelo do texto do erro ou para outro de GET /v1/models.
504 upstream_timeoutA rede não começou a responder a tempo. Repita a requisição; para respostas longas, ative stream: true.
502Falha do lado do gateway ou da rede — a chave não tem nada a ver com isso. Tente de novo mais tarde; o estado da rede está na página Status da rede.

Todos os códigos de resposta e limites estão na seção Erros e limites.

Relatório#

No fim, informe ao usuário:

  • qual ferramenta foi configurada e qual arquivo de configuração foi gravado (o caminho é impresso pelo instalador e uma cópia da anterior fica ao lado);
  • o endereço base e o identificador do modelo;
  • o resultado da verificação: o código de resposta e a resposta do modelo — ou por que não foi possível verificar;
  • o que ainda cabe ao próprio usuário fazer: por exemplo, reiniciar a ferramenta ou adicionar saldo.

Não inclua a chave no relatório.

Endereços para máquinas#

EndereçoO que tem lá
/llms.txtÍndice da documentação para modelos de linguagem.
/llms-full.txtToda a documentação em um único arquivo.
/docs/<page>.mdVersão em Markdown da página de documentação: o mesmo endereço com .md no final (/docs/models.md) ou uma requisição da página com o cabeçalho Accept: text/markdown.
GET /v1/capabilitiesRecursos e limites do gateway — o campo limits.
GET /v1/modelsModelos disponíveis no momento.
GET /api/pricingPreços por modelo a cada 1M de tokens e taxas.
GET /v1/network-statusStatus dos modelos e incidentes.

Habilidade para o agente#

As instruções podem ser instaladas como uma habilidade (skill) para o agente — assim ficam sempre à mão, sem precisar de prompt:

Bash
npx skills add https://gate.joingonka.ai