> ## Documentation Index
> Fetch the complete documentation index at: https://docs.jiekou.ai/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> JieKou AI model APIs are OpenAI-compatible. Base URL for users in mainland China (direct, no VPN): https://api.highwayapi.ai/openai; elsewhere: https://api.jiekou.ai/openai. Anthropic-compatible base URL: https://api.highwayapi.ai/anthropic or https://api.jiekou.ai/anthropic.
> Authenticate with `Authorization: Bearer <API_KEY>`; with Anthropic SDKs or Claude Code, pass the same key as `ANTHROPIC_AUTH_TOKEN`. Users create keys at https://jiekou.ai/settings/key-management. Never print or hardcode a real key.
> Get current model IDs from GET https://api.jiekou.ai/openai/v1/models instead of reusing model names from memory.

# Magpie

## O que é o Magpie?

O magpie permite que cada Agent use todos os modelos. Basta adicionar cada provedor uma única vez — DeepSeek, Kimi, GLM, Qwen, OpenRouter, Ollama, ou as assinaturas do Claude e do ChatGPT que você já paga — e depois selecioná-los com um clique no Codex, no Claude Code, no Gemini CLI ou em qualquer Agent.

Cada Agent escreve os modelos em seu próprio arquivo de configuração, com formatos diferentes, e a key e a base URL ficam cada uma por sua conta. As assinaturas que você paga só funcionam em um Agent. O magpie reúne tudo isso em um único aplicativo e um gateway local:

* Qualquer Agent com qualquer modelo, selecionados em uma única tabela. O magpie altera apenas a chave que precisa ser alterada na configuração do Agent.
* Um provider funciona em todos os lugares: API key, modelos locais, ou as assinaturas do Claude, ChatGPT, Copilot, Gemini e Grok nas quais você está logado.
* Sem interrupção quando a cota se esgota: a próxima conta do mesmo provedor assume automaticamente, e o grupo de roteamento pode alternar para outros modelos ou provedores, sem que o Agent veja nenhum erro. Quando há apenas uma conta e nenhum grupo de roteamento configurado, não há alternativa disponível, e o erro é retornado ao Agent exatamente como ocorreu.
* As chaves não saem do seu computador: após ativar o mascaramento em Configurações → Privacidade (desativado por padrão), chaves, senhas e e-mails presentes nos prompts são mascarados localmente antes de a requisição sair do computador, e os valores originais são restaurados na resposta.

Se você usa mais de um Agent, mais de um provider ou mais de uma conta, ele é para você. Se você usa apenas um Agent, apenas a assinatura própria dele, e isso atende às suas necessidades, então não precisa do magpie.

Compatível com macOS, Windows e Linux (aplicativo de barra de menu, janela, TUI, interface web e CLI), e também pode ser executado em Docker e Termux.

## Como integrar o Interface AI ao Magpie?

### Obter a API Key

1. Acesse o site oficial jiekou.ai para se registrar.

2. Entre no painel de administração, clique em "Minha conta" no canto superior direito e selecione "Gerenciamento de chaves de API" na lista suspensa.

   ![](https://mintcdn.com/jiekou/f-T_E3hNj8sGYUsR/images/magpie-01.png?fit=max\&auto=format\&n=f-T_E3hNj8sGYUsR\&q=85\&s=c123fc8d8326ed7b03e6275713012eb5)

3. Clique em "Criar" e insira o nome da chave. Recomenda-se usar um nome fácil de identificar, para facilitar a distinção, no console, entre chaves com diferentes finalidades.

   ![](https://mintcdn.com/jiekou/f-T_E3hNj8sGYUsR/images/magpie-02.png?fit=max\&auto=format\&n=f-T_E3hNj8sGYUsR\&q=85\&s=6e87360fa491250e85699d119031cbf4)

4. Clique em copiar e anote a Key gerada. Não é possível visualizá-la novamente no console, portanto, guarde-a com segurança para uso futuro.

### Integrar o Interface AI ao Magpie

1. Adicione um provedor personalizado em Provedores

   ![](https://mintcdn.com/jiekou/eY20tqhq6niA3Adp/images/magpie-03.png?fit=max\&auto=format\&n=eY20tqhq6niA3Adp\&q=85\&s=fb3087b909f1f06080f6ca4813ab44ef)

2. Insira a API Key copiada anteriormente, preencha a URL e selecione o formato de API (API Endpoint) adequado ao modelo que deseja chamar

* URL de conexão direta na China: [https://api.highwayapi.ai/openai](https://api.highwayapi.ai/openai)
* URL internacional: [https://api.jiekou.ai/openai](https://api.jiekou.ai/openai)

  ![](https://mintcdn.com/jiekou/eY20tqhq6niA3Adp/images/magpie-04.png?fit=max\&auto=format\&n=eY20tqhq6niA3Adp\&q=85\&s=8ffe91b383d1f6b8e217d0c306c53806)

3. Insira o ID do modelo ou clique em "Obter modelos" para visualizar a lista de modelos e clique em "Adicionar" para concluir a integração


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.