Documentazione KiApi: integrazione in 5 minuti

Inizia: URL base e autenticazione

La KiApi è completamente conforme all'API OpenAI. Puoi utilizzare l'ecosistema esistente di SDK e client modificando la base_url. L'URL di base per tutte le richieste è https://api.kiapis.com/v1. L'autenticazione avviene esclusivamente tramite una chiave API che ottieni dopo la registrazione nella tua pagina dashboard. Questo chiave deve essere trasmessa nell'header HTTP Authorization: Bearer <IHR_API_SCHLÜSSEL>. Puoi generare una nuova chiave in qualsiasi momento, rendendo la precedente non valida.

A differenza di altri servizi, non offriamo endpoint complessi per embedding o fine-tuning. Il nostro focus è sulla pura generazione di testo. KiApi è il tuo collegamento diretto a un modello ottimizzato per risposte senza censura. Assicurati di configurare correttamente il tuo ambiente prima di inviare la tua prima richiesta.

POST /v1/chat/completions: generazione di testo

Il cuore dell'API è l'endpoint POST /v1/chat/completions. Qui invii una lista di messaggi (system, user, assistant) e ricevi una risposta testuale. Il parametro model ID deve essere impostato su uncensored. La risposta è sincrona e contiene immediatamente il frammento di testo generato e i metadati sull'utilizzo dei token.

La struttura della richiesta segue il formato standard. Puoi definire ruoli per strutturare chiaramente il contesto. Il sistema elabora l'input e genera una risposta basata sul comportamento appreso dal modello. Questo è il metodo principale per quasi tutte le applicazioni di testo, dai chatbot all'analisi del testo.

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

La risposta contiene un oggetto JSON con i contenuti generati. Assicurati di estrarre la sezione content dalla risposta per utilizzarla nella tua applicazione. Non vengono restituiti metadati aggiuntivi come il costo per richiesta nella risposta standard; queste informazioni le trovi nella dashboard.

Streaming con Server-Sent Events (SSE)

Per le applicazioni che richiedono output immediato, KiApi supporta lo streaming tramite Server-Sent Events (SSE). Attivalo impostando "stream": true nel corpo della richiesta. Invece di attendere una risposta completa, ricevi un flusso di patch JSON che contengono gradualmente il testo generato.

Questo è particolarmente utile per le interfacce chat, dove il feedback immediato migliora l'esperienza utente. L'API di streaming di KiApi ti permette di ridurre la latenza e creare la sensazione di una conversazione in tempo reale. Il client deve analizzare il flusso e unire i frammenti fino alla segnalazione della fine dello stream.

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 lo streaming, le statistiche di utilizzo dei token vengono spesso restituite alla fine dello stream nell'ultimo evento. Questo permette una fatturazione precisa basata sulla lunghezza effettiva della generazione. Assicurati che il tuo codice client gestisca la fine dello stream per rilasciare correttamente le risorse.

Tool calling e chiamate di funzioni

Il modello supporta il tool calling, noto anche come function calling. Questo permette al LLM di restituire dati JSON strutturati che rappresentano funzioni o azioni specifiche nella tua applicazione. Definisci gli strumenti disponibili nel corpo della richiesta e il modello decide in base all'input dell'utente quando chiamare uno strumento.

La struttura delle definizioni degli strumenti segue lo standard OpenAI. Puoi specificare più strumenti e il modello sceglie quello più adatto. La risposta contiene una lista di chiamate di strumenti che puoi poi eseguire nella tua logica di backend. Questo amplia le possibilità di KiApi ben oltre la pura generazione di testo.

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)

Usa il tool calling per automatizzare flussi di lavoro complessi. Il modello fornisce i parametri per lo strumento direttamente in formato JSON. Non devi usare parser esterni per la risposta poiché la struttura proviene direttamente dal modello. Questo rende l'integrazione nei sistemi esistenti notevolmente più semplice e affidabile.

GET /v1/models: modelli disponibili

L'endpoint GET /v1/models elenca i modelli disponibili a cui è possibile accedere tramite l'API. Questo è utile per verificare dinamicamente quali modelli sono disponibili o per confermare l'ID del modello. Di solito riceverai una lista con il modello uncensored.

La risposta contiene metadati sul modello, come ID, proprietario e data di creazione. A differenza di alcune altre API, la risposta standard non contiene direttamente la lunghezza massima del contesto o prezzi specifici. Queste informazioni devono essere ricavate dalla documentazione o dalla dashboard. Tuttavia questo endpoint è indispensabile per la configurazione automatica dei client.

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

Usa questo endpoint per adattare la tua applicazione ai cambiamenti futuri. Quando vengono aggiunti nuovi modelli, appariranno automaticamente in questa lista. Il modello corrente uncensored è l'unico modello disponibile ed è caratterizzato dalla descrizione come grande modello linguistico ottimizzato per contenuti senza censura.

Limiti di velocità e codici di errore

Per garantire la stabilità del servizio, sono in vigore certi limiti. Per chiave API sono consentite 300 richieste al minuto. Il corpo massimo della richiesta è di 8 MB. Se superi questi limiti, riceverai il codice di stato HTTP 429 Too Many Requests. Pianifica la tua applicazione per implementare tentativi di ripetizione con backoff esponenziale.

Altri codici di errore comuni sono 401 Unauthorized se la chiave API non è valida e 402 Payment Required se il tuo credito è esaurito. KiApi utilizza un modello prepaid, quindi le richieste senza credito vengono rifiutate immediatamente. Assicurati di verificare regolarmente i saldi del tuo account.

La finestra di contesto è di 100.000 token per input e output combinati. Se superi questo limite, viene restituito un messaggio di errore. KiApi è una soluzione affidabile per gli sviluppatori che apprezzano regole chiare e limiti trasparenti.