URL Base e Autenticação
Nossa API segue a interface padrão de chat-completions da OpenAI. Para integrar, atualize a configuração do seu cliente com nosso URL base específico e uma chave codex api válida. Você gera essa chave durante o cadastro no painel. O endpoint aceita requisições padrão e de streaming, tornando-o pronto para usar como substituição para a maioria dos agentes de codificação que esperam uma estrutura compatível com OpenAI.
A autenticação depende do cabeçalho Authorization. Inclua sua chave como token Bearer. Se você estiver usando um proxy ou um framework de agente personalizado, certifique-se de que ele respeite os cabeçalhos HTTP padrão. O serviço é independente; não passa por outros fornecedores ou agrega modelos. Você está se conectando diretamente ao nosso LLM sem censura.
Enviar Chat Completion
Comece testando uma solicitação de texto simples. Isso confirma que sua autenticação e URL base estão corretos. O endpoint aceita uma lista de mensagens com papéis como user ou assistant. O ID do modelo é sempre uncensored. Esta solicitação retorna uma resposta de conclusão padrão. Use isso para verificar se seu agente pode analisar a estrutura JSON antes de prosseguir para prompts complexos.
Certifique-se de que sua carga útil permaneça dentro do limite de corpo de 8 MB. Janelas de contexto grandes são suportadas, mas a contagem total de tokens (entrada mais saída) deve permanecer abaixo de 100.000 tokens. Se você exceder esses limites, o servidor retornará um erro. Comece com um teste pequeno para confirmar a conectividade.
curl https://api.getcodexapi.com/v1/chat/completions \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
}'Habilitar Streaming (SSE)
Para agentes de codificação que precisam de geração de tokens em tempo real, ative o streaming. Defina o parâmetro stream como true no corpo da sua solicitação. O servidor retorna uma sequência de Eventos Enviados pelo Servidor (SSE) em vez de um único objeto JSON. Cada evento contém um fragmento parcial da resposta. Isso reduz a latência percebida para seus usuários e permite que seu agente processe tokens conforme eles chegam.
O streaming não altera o preço ou a contagem de tokens. Você ainda paga pelos tokens totais de entrada e saída. Processe o fluxo SSE no código do seu cliente para acumular a resposta final ou processá-la incrementalmente. Isso é ideal para geração de código onde resultados intermediários são úteis.
stream = client.chat.completions.create(
model="uncensored",
messages=[{"role": "user", "content": "Tell the story in second person."}],
stream=True,
)
for chunk in stream:
if chunk.choices and chunk.choices[0].delta.content:
print(chunk.choices[0].delta.content, end="", flush=True)Usar Tool Calling
Nosso modelo suporta chamada de funções, permitindo que seu agente execute ferramentas externas. Defina suas funções no parâmetro tools. O modelo retornará uma resposta com uma chamada de ferramenta em vez de texto simples se determinar que uma função é necessária. Seu agente deve analisar essa resposta e executar a ferramenta, em seguida, alimentar o resultado de volta na conversa.
Essa capacidade é essencial para agentes de codificação que precisam executar código, consultar bancos de dados ou buscar dados em tempo real. O esquema de ferramenta segue o formato padrão da OpenAI. Certifique-se de que seu agente lide corretamente com o ciclo entre o modelo e sua lógica de execução de ferramentas. Isso mantém a janela de contexto de forma eficiente, substituindo texto bruto por resultados de ferramentas estruturados.
from openai import OpenAI
client = OpenAI(base_url="https://api.getcodexapi.com/v1", api_key="YOUR_KEY")
resp = client.chat.completions.create(
model="uncensored",
messages=[{"role": "user", "content": "Summarise this thread without softening it."}],
)
print(resp.choices[0].message.content)Verificar Modelos Disponíveis
Use o endpoint GET /v1/models para verificar os modelos disponíveis. Este endpoint retorna uma lista de objetos de modelo, incluindo seus IDs e datas de criação. Nossa API serve um único modelo: uncensored. Diferente de relays de proxy que agregam vários fornecedores, fornecemos um endpoint dedicado para um LLM otimizado. Isso garante comportamento consistente e desempenho previsível para suas tarefas de codificação.
Consulte este endpoint para confirmar que seu cliente está conectado ao serviço correto. Ele retorna campos padrão de metadados. Você não precisa gerenciar a seleção de modelo manualmente. O cliente simplesmente solicita o ID do modelo uncensored em todas as conclusões de chat. Isso simplifica a integração e evita erros de roteamento.
import OpenAI from "openai";
const client = new OpenAI({ baseURL: "https://api.getcodexapi.com/v1", apiKey: process.env.API_KEY });
const resp = await client.chat.completions.create({
model: "uncensored",
messages: [{ role: "user", content: "Draft a villain monologue for my game." }],
});
console.log(resp.choices[0].message.content);Limites de Requisição e Restrições
Monitore seu uso para evitar interrupções. A API impõe um limite de 300 requisições por minuto por chave. Se você exceder isso, receberá um erro 429 Too Many Requests. O tamanho do corpo da solicitação é limitado a 8 MB. Essas restrições garantem desempenho estável para agentes de alto throughput. Ajuste a frequência de solicitação do seu cliente se estiver processando grandes lotes.
Erros de autenticação retornam o status 401 se a chave for inválida. Créditos insuficientes resultam no status 402. Certifique-se de que seu saldo pré-pago seja positivo antes de enviar requisições. Os créditos não expiram, então você pode recarregar quando for conveniente. A chave codex api pode ser regenerada a qualquer momento, revogando a antiga instantaneamente. Mantenha sua chave segura.
