Documentação KiApi: Integração em 5 minutos

Início: URL base e autenticação

A KiApi é totalmente compatível com a API da OpenAI. Você pode aproveitar o ecossistema existente de SDKs e clientes ajustando a base_url. A URL base para todas as requisições é https://api.kiapis.com/v1. A autenticação é feita exclusivamente por meio de uma chave de API, que você recebe após o registro na página do seu painel. Essa chave deve ser enviada no cabeçalho HTTP Authorization: Bearer <IHR_API_SCHLÜSSEL>. Você pode gerar uma nova chave a qualquer momento, tornando a anterior inválida.

Ao contrário de outros serviços, não oferecemos endpoints complexos para embeddings ou fine-tuning. Nosso foco é a geração pura de texto. A KiApi é sua conexão direta com um modelo otimizado para respostas sem censura. Certifique-se de configurar seu ambiente corretamente antes de enviar sua primeira requisição.

POST /v1/chat/completions: Geração de texto

O núcleo da API é o endpoint POST /v1/chat/completions. Aqui você envia uma lista de mensagens (sistema, usuário, assistente) e recebe uma resposta textual. O parâmetro de ID do modelo deve ser definido como uncensored. A resposta é síncrona e contém imediatamente o fragmento de texto gerado e metadados sobre o uso de tokens.

A estrutura da requisição segue o formato padrão. Você pode definir roles para estruturar claramente o contexto. O sistema processa a entrada e gera uma resposta baseada no comportamento aprendido do modelo. Este é o método principal para quase todas as aplicações de texto, de chatbots a análise de texto.

Kopierencurl https://api.kiapis.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."}]
  }'

A resposta contém um objeto JSON com o conteúdo gerado. Certifique-se de extrair a área content da resposta para usá-la em sua aplicação. Metadados adicionais, como custo por requisição, não são retornados na resposta padrão; você os encontra no painel.

Streaming com Server-Sent Events (SSE)

Para aplicações que exigem saída imediata, a KiApi suporta streaming via Server-Sent Events (SSE). Ative isso definindo "stream": true no corpo da requisição. Em vez de esperar por uma resposta completa, você recebe um fluxo de patches JSON contendo gradualmente o texto gerado.

Isso é especialmente útil para interfaces de chat, onde o feedback imediato melhora a experiência do usuário. A API de streaming da KiApi permite reduzir a latência e criar a sensação de uma conversa em tempo real. O cliente deve analisar o fluxo e concatenar os fragmentos até que o fim do stream seja sinalizado.

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

Durante o streaming, as estatísticas de uso de tokens são frequentemente retornadas no final do fluxo no último evento. Isso permite cobrança precisa baseada no comprimento real da geração. Certifique-se de que seu código de cliente lide com o fim do stream para liberar recursos corretamente.

Chamada de funções e ferramentas

O modelo suporta chamada de ferramentas (tool calling), também conhecida como chamada de funções. Isso permite que o LLM retorne dados JSON estruturados que representam funções ou ações específicas em sua aplicação. Você define as ferramentas disponíveis no corpo da requisição, e o modelo decide com base na entrada do usuário quando chamar uma ferramenta.

A estrutura das definições de ferramentas segue o padrão OpenAI. Você pode especificar várias ferramentas, e o modelo escolherá a mais adequada. A resposta contém uma lista de chamadas de ferramentas que você pode executar na lógica do seu backend. Isso amplia significativamente as possibilidades da KiApi além da geração pura de texto.

Kopierenfrom openai import OpenAI

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

Use chamada de ferramentas para automatizar fluxos de trabalho complexos. O modelo fornece os parâmetros para a ferramenta diretamente no formato JSON. Você não precisa usar parsers externos para a resposta, pois a estrutura vem diretamente do modelo. Isso torna a integração em sistemas existentes muito mais fácil e confiável.

GET /v1/models: Modelos disponíveis

O endpoint GET /v1/models lista os modelos disponíveis que podem ser acessados via API. Isso é útil para verificar dinamicamente quais modelos estão disponíveis ou confirmar o ID do modelo. Normalmente, você receberá uma lista contendo o modelo uncensored.

A resposta contém metadados sobre o modelo, como ID, proprietário e data de criação. Ao contrário de algumas outras APIs, a resposta padrão não contém diretamente o comprimento máximo da janela de contexto ou preços específicos. Essas informações devem ser obtidas da documentação ou do painel. Este endpoint, no entanto, é indispensável para a configuração automática de clientes.

Kopierenimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.kiapis.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 este endpoint para adaptar sua aplicação a futuras alterações. Quando novos modelos forem adicionados, eles aparecerão automaticamente nesta lista. O modelo atual uncensored é o único modelo disponível e é caracterizado na descrição como um grande modelo de linguagem otimizado para conteúdo sem censura.

Limites de requisições e códigos de erro

Para garantir a estabilidade do serviço, existem certos limites. São permitidas 300 requisições por minuto por chave de API. O corpo máximo da requisição é de 8 MB. Se você exceder esses limites, receberá o código de status HTTP 429 Too Many Requests. Planeje sua aplicação para implementar tentativas de repetição com backoff exponencial.

Outros códigos de erro comuns são 401 Unauthorized, quando a chave de API é inválida, e 402 Payment Required, quando seu crédito se esgota. A KiApi usa um modelo pré-pago, portanto, as requisições sem crédito são rejeitadas imediatamente. Certifique-se de verificar regularmente o saldo da sua conta.

A janela de contexto é de 100.000 tokens para entrada e saída combinadas. Se você exceder esse limite, uma mensagem de erro será retornada. A KiApi é uma solução confiável para desenvolvedores que valorizam regras claras e limites transparentes.