Documentação da API Kimicode

URL Base e Autenticação

Conecte-se à API usando o URL base fornecido e uma chave de token pré-pago. Você se autentica passando sua chave de API no cabeçalho da solicitação, garantindo que apenas sua conta acesse seus créditos. Cadastre-se via Google ou e-mail para receber sua chave imediatamente sem verificação por telefone.

Copycurl https://api.kimicodeapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "What is the current rate limit for free tier users?"}]
  }'

Suas solicitações visam o endpoint padrão compatível com OpenAI. Este design permite que você substitua nosso serviço sem reescrever o código do seu cliente existente, desde que atualize a URL base e as credenciais.

Endpoint Chat Completions

Envie mensagens para o modelo usando o POST /v1/chat/completions endpoint. Você deve especificar o ID do modelo como uncensored para acessar o modelo de linguagem grande otimizado executado em nossos servidores. O sistema aceita funções de mensagem padrão como user ou assistant para conversas de múltiplos turnos.

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.kimicodeapi.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)

Este endpoint lida com entrada de texto e retorna texto gerado. Não suporta embeddings, imagens ou áudio. Concentre-se na estrutura do seu prompt para obter os melhores resultados do modelo sem censura.

Respostas em Streaming (SSE)

Ative a entrega de tokens em tempo real definindo o parâmetro stream como true na solicitação. A API retorna fragmentos de Server-Sent Events (SSE), permitindo que seu aplicativo exiba o texto conforme é gerado. O último fragmento contém as estatísticas completas de uso de tokens para faturamento.

Copystream = 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)

O streaming reduz a latência percebida para o usuário final. Você pode processar cada token conforme ele chega, o que é ideal para interfaces de chat. Lembre-se de que o streaming não altera o comportamento subjacente do modelo ou o preço dos tokens.

Chamada de Função e Ferramentas

Defina ferramentas na solicitação para permitir que o modelo retorne chamadas de ferramentas estruturadas. A API suporta parâmetros tool_choice, permitindo forçar o modelo a usar uma ferramenta específica ou decidir de forma autônoma. Este recurso funciona com formatos padrão de ferramentas OpenAI, facilitando a integração.

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.kimicodeapi.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);

Use chamadas de função para extrair dados ou acionar ações em seus aplicativos. O modelo interpreta as definições de ferramenta e retorna objetos JSON contendo os argumentos necessários. Essa capacidade estende a API além da simples geração de texto.

Modo JSON e Parâmetros

Imponha saída JSON estrita definindo response_format para {"type": "json_object"}. Isso garante que o modelo retorne JSON, o que é crucial para análise programática. Você também pode ajustar parâmetros como temperatura, top_p e sequências de parada para controlar a criatividade e o comprimento da saída.

O modelo suporta uma janela de contexto de 100.000 tokens. Isso permite enviar grandes quantidades de contexto em uma única solicitação. A saída máxima é de 16.000 tokens por solicitação, ou 2.048 se você não especificar max_tokens.

Limites, Erros e Contexto

Monitore seus limites de requisições para evitar interrupções no serviço. A API permite 300 requisições por minuto por chave e até 8 requisições simultâneas. O corpo da sua requisição deve permanecer abaixo de 8 MB. Se você exceder esses limites, receberá um erro de limite de taxa 429.

Falhas de autenticação retornam um erro 401 se a chave for inválida. Um erro 402 indica crédito pré-pago insuficiente. Erros durante a geração não consomem seus tokens. A janela de contexto inclui tokens de prompt e conclusão. Crédito não utilizado nunca expira, garantindo que seu saldo pré-pago permaneça disponível para projetos futuros.