Skip to main content
URL base: https://router.flatkey.ai A geração de texto é feita por meio de POST /v1/chat/completions, que corresponde exatamente à API de Chat Completions da OpenAI. Qualquer cliente compatível com OpenAI funciona após você alterar a URL base.

Sem reescrita necessária

Mantenha seu código de requisição existente e aponte base_url para https://router.flatkey.ai/v1.

Uma chave, todos os modelos

Troque de modelos alterando o campo model. Nada mais muda.

Faça sua primeira chamada

Escolha um modelo

Liste tudo que sua conta pode acessar e mantenha os modelos de texto:
Navegue pela mesma lista com preços, tamanho do contexto e latência no diretório de modelos. Um ponto de partida prático:

Transmita a resposta

Defina stream: true para receber tokens conforme são produzidos:
Cada chunk carrega um delta parcial em vez de uma mensagem completa.

Chame suas próprias funções

Passe definições de ferramentas e o modelo decide quando invocá-las:
Para fechar o loop, anexe a mensagem do assistente, depois uma mensagem por resultado de ferramenta identificada por tool_call_id, e envie toda a thread de volta.
Quando uma ferramenta é acionada, finish_reason é tool_calls, não stop. Código que verifica apenas stop vai descartar a chamada silenciosamente.
A chamada de ferramentas é uma capacidade do modelo, não do Flatkey. As famílias GPT, Claude, Gemini, Qwen, DeepSeek e GLM oferecem suporte. Modelos de imagem, vídeo e áudio ignoram um array tools.

Force um formato JSON

Use response_format quando precisar analisar a resposta:
{"type": "json_object"} também funciona quando você precisa apenas de JSON válido sem um esquema fixo.

Leia o uso de tokens

Cada resposta traz as contagens que são cobradas:
Famílias de modelos diferentes tokenizam de forma diferente, portanto o mesmo texto custa um número diferente de tokens em modelos diferentes. Use usage em vez de estimar com base na contagem de caracteres. O custo por requisição também aparece nos Registros de uso.

Solução de problemas

No available channel for model ... Esse modelo não está roteável no momento. Escolha outro id em /v1/models. Tentar novamente com o mesmo modelo não resolve isso. A resposta para no meio de uma frase finish_reason é length. Aumente max_tokens. As chamadas de ferramentas nunca são acionadas Confirme se o modelo suporta ferramentas e verifique se tool_choice não está definido como none.

Próximos passos

Referência da API

Todos os parâmetros e campos de resposta.

Guia do SDK OpenAI

Integre Flatkey em um projeto OpenAI existente.