KiApi Documentatie: Integratie in 5 minuten

Aan de slag: basis-URL en authenticatie

De KiApi is volledig compatibel met de OpenAI API. Je kunt het bestaande ecosysteem van SDK's en clients gebruiken door de base_url aan te passen. De basis-URL voor alle verzoeken is https://api.kiapis.com/v1. Authenticatie gebeurt uitsluitend via een API-sleutel, die je na registratie op je dashboardpagina ontvangt. Deze sleutel moet worden meegegeven in de HTTP-header Authorization: Bearer <IHR_API_SCHLÜSSEL>. Je kunt op elk moment een nieuwe sleutel genereren, waardoor de oude ongeldig wordt.

In tegenstelling tot andere diensten bieden we geen complexe endpoints voor embeddings of fine-tuning. Onze focus ligt op pure tekstgeneratie. KiApi is jouw directe verbinding met een model dat is geoptimaliseerd voor ongecensureerde antwoorden. Zorg ervoor dat je je omgeving correct configureert voordat je je eerste verzoek verstuurt.

POST /v1/chat/completions: tekstgeneratie

Het hart van de API is de endpoint POST /v1/chat/completions. Hier verzend je een lijst met berichten (system, user, assistant) en ontvang je een tekstueel antwoord. De model-id parameter moet op uncensored worden ingesteld. Het antwoord is synchroon en bevat direct het gegenereerde tekstfragment plus metadata over token-gebruik.

De structuur van het verzoek volgt het standaardformaat. Je kunt rollen definiëren om de context duidelijk te structureren. Het systeem verwerkt de invoer en genereert een antwoord op basis van het geleerde gedrag van het model. Dit is de primaire methode voor bijna alle tekstapplicaties, van chatbots tot tekstanalyse.

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."}]
  }'

Dit antwoord bevat een JSON-object met de gegenereerde inhoud. Zorg ervoor dat je de content-velden uit het antwoord haalt om ze in je applicatie te gebruiken. Er worden geen extra metadata zoals kosten per verzoek in het standaardantwoord teruggegeven; deze vind je in het dashboard.

Streaming met Server-Sent Events (SSE)

Voor applicaties die directe uitvoer nodig hebben, ondersteunt KiApi streaming via Server-Sent Events (SSE). Activeer dit door in de request body "stream": true in te stellen. In plaats van te wachten op een compleet antwoord, ontvang je een stroom van JSON-patches die stapsgewijs de gegenereerde tekst bevatten.

Dit is vooral nuttig voor chatinterfaces, waar directe feedback de gebruikerservaring verbetert. KiApi als streaming api stelt je in staat om latentie te verminderen en het gevoel van een realtime conversatie te creëren. De client moet de stroom parseren en de fragmenten samenvoegen tot het stream-einde wordt gemeld.

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)

Bij streaming worden de token-gebruiksstatistieken vaak aan het einde van de stream in het laatste event teruggegeven. Dit maakt een nauwkeurige facturatie op basis van de werkelijke generatielengte mogelijk. Zorg ervoor dat je clientcode omgaat met het stream-einde om resources correct vrij te geven.

Tool calling en function calling

Het model ondersteunt tool calling, ook wel function calling genoemd. Dit stelt het LLM in staat gestructureerde JSON-gegevens terug te geven die specifieke functies of acties in je applicatie vertegenwoordigen. Je definieert de beschikbare tools in de request body, en het model beslist op basis van de gebruikersinvoer wanneer een tool moet worden aangeroepen.

De structuur van de tool-definities volgt de OpenAI-standaard. Je kunt meerdere tools opgeven, en het model kiest de meest geschikte. Het antwoord bevat een lijst met tool calls die je vervolgens in je backend-logica kunt uitvoeren. Dit breidt de mogelijkheden van KiApi ver uit voorbij pure tekstgeneratie.

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)

Gebruik tool calling om complexe workflows te automatiseren. Het model levert de parameters voor de tool direct in JSON-formaat. Je hoeft geen externe parsers voor het antwoord te gebruiken, omdat de structuur direct van het model komt. Dit maakt de integratie in bestaande systemen aanzienlijk eenvoudiger en betrouwbaarder.

GET /v1/models: beschikbare modellen

De endpoint GET /v1/models somt de beschikbare modellen op die via de API kunnen worden benaderd. Dit is nuttig om dynamisch te controleren welke modellen beschikbaar zijn, of om de model-id te bevestigen. Je ontvangt doorgaans een lijst met het model uncensored.

Het antwoord bevat metadata over het model, zoals id, eigenaar en creatiedatum. In tegenstelling tot sommige andere APIs bevat het standaardantwoord niet direct de maximale contextlengte of specifieke prijzen. Deze informatie moet uit de documentatie of het dashboard worden gehaald. Deze endpoint is echter onmisbaar voor de automatische configuratie van clients.

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);

Gebruik deze endpoint om je applicatie aan te passen aan toekomstige wijzigingen. Als er nieuwe modellen worden toegevoegd, verschijnen ze automatisch in deze lijst. Het huidige model uncensored is het enige beschikbare model en wordt in de beschrijving gekenmerkt als een groot taalmodel dat is geoptimaliseerd voor ongecensureerde inhoud.

Rate limits en foutcodes

Om de stabiliteit van de dienst te garanderen gelden bepaalde limieten. Per API-sleutel zijn 300 verzoeken per minuut toegestaan. De maximale request body is 8 MB. Als je deze limieten overschrijdt, ontvang je de HTTP-statuscode 429 Too Many Requests. Plan je applicatie dienovereenkomstig om retry's met exponentiële backoff te implementeren.

Andere veelvoorkomende foutcodes zijn 401 Unauthorized als de API-sleutel ongeldig is, en 402 Payment Required als je tegoed op is. De KiApi hanteert een prepaid-model, waardoor verzoeken zonder tegoed direct worden afgewezen. Zorg ervoor dat je je saldo's regelmatig controleert.

Het contextvenster bedraagt 100.000 tokens voor invoer en uitvoer samen. Als je dit limiet overschrijdt, wordt een foutmelding teruggegeven. De KiApi is een betrouwbare oplossing voor ontwikkelaars die duidelijke regels en transparante limieten waarderen.