KiApi Dokumentacja: integracja w 5 minut

Pierwsze kroki: URL bazowy i uwierzytelnianie

KiApi jest w pełni zgodny z API OpenAI. Możesz korzystać z istniejącego ekosystemu SDK i klientów, dostosowując base_url. Podstawowy URL dla wszystkich zapytań to https://api.kiapis.com/v1. Autoryzacja odbywa się wyłącznie za pomocą klucza API, który otrzymasz po rejestracji na stronie pulpitu nawigacyjnego. Klucz ten musi być przekazany w nagłówku HTTP Authorization: Bearer <IHR_API_SCHLÜSSEL>. Możesz wygenerować nowy klucz w dowolnym momencie, co unieważni poprzedni.

W przeciwieństwie do innych usług nie oferujemy skomplikowanych endpointów do osadzania lub dostrajania. Skupiamy się na czystym generowaniu tekstu. KiApi to Twoja bezpośrednia droga do modelu zoptymalizowanego pod bezcenzuralne odpowiedzi. Upewnij się, że poprawnie skonfigurujesz środowisko przed wysłaniem pierwszego zapytania.

POST /v1/chat/completions: generowanie tekstu

Sercem API jest endpoint POST /v1/chat/completions. Wysyłasz tam listę wiadomości (system, użytkownik, asystent) i otrzymujesz odpowiedź tekstową. Parametr ID modelu musi być ustawiony na uncensored. Odpowiedź jest synchroniczna i zawiera natychmiast wygenerowany fragment tekstu oraz metadane dotyczące użycia tokenów.

Struktura zapytania jest zgodna ze standardem. Możesz definiować role, aby jasno zstrukturować kontekst. System przetwarza wejście i generuje odpowiedź na podstawie nauczonego zachowania modelu. Jest to główna metoda dla większości aplikacji tekstowych, od botów czatowych po analizę tekstu.

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

Odpowiedź zawiera obiekt JSON z wygenerowaną treścią. Upewnij się, że ekstrahujesz obszar content z odpowiedzi, aby użyć go w aplikacji. Standardowa odpowiedź nie zwraca dodatkowych metadanych, takich jak koszt zapytania; znajdziesz je w panelu.

Strumieniowanie za pomocą SSE

Dla aplikacji wymagających natychmiastowej odpowiedzi KiApi obsługuje strumieniowanie przez Server-Sent Events (SSE). Włącz je, ustawiając w ciele żądania "stream": true. Zamiast czekać na pełną odpowiedź, otrzymasz strumień patchy JSON zawierających stopniowo generowany tekst.

Jest to szczególnie przydatne w interfejsach czatu, gdzie natychmiastowa informacja zwrotna poprawia doświadczenie użytkownika. API KiApi ze strumieniowaniem pozwala zmniejszyć opóźnienia i stworzyć wrażenie rozmowy w czasie rzeczywistym. Klient musi parsować strumień i łączyć fragmenty, aż do sygnału końca strumienia.

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)

Podczas strumieniowania statystyki użycia tokenów są często zwracane na końcu strumienia w ostatnim zdarzeniu. Pozwala to na dokładne rozliczanie na podstawie rzeczywistej długości generowania. Upewnij się, że kod klienta obsługuje koniec strumienia, aby prawidłowo zwolnić zasoby.

Wywoływanie funkcji i narzędzi

Model obsługuje wywoływanie narzędzi, znane również jako wywoływanie funkcji. Pozwala to LLM na zwracanie strukturyzowanych danych JSON reprezentujących konkretne funkcje lub akcje w Twojej aplikacji. Definiujesz dostępne narzędzia w ciele żądania, a model decyduje na podstawie wejścia użytkownika, kiedy wywołać narzędzie.

Struktura definicji narzędzi jest zgodna ze standardem OpenAI. Możesz podać wiele narzędzi, a model wybierze najbardziej odpowiednie. Odpowiedź zawiera listę wywołań narzędzi, które możesz następnie wykonać w logice backendu. To znacznie rozszerza możliwości KiApi poza czystym generowaniem tekstu.

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)

Wykorzystaj wywoływanie narzędzi do automatyzacji złożonych przepływów pracy. Model dostarcza parametry dla narzędzia bezpośrednio w formacie JSON. Nie musisz używać zewnętrznych parserów odpowiedzi, ponieważ struktura pochodzi bezpośrednio od modelu. Ułatwia to i zwiększa niezawodność integracji z istniejącymi systemami.

GET /v1/models: dostępne modele

Endpoint GET /v1/models wyświetla dostępne modele, które można wywoływać przez API. Jest to przydatne do dynamicznego sprawdzania dostępności modeli lub potwierdzania ich ID. Zazwyczaj otrzymasz listę zawierającą model uncensored.

Odpowiedź zawiera metadane modelu, takie jak ID, właściciel i data utworzenia. W przeciwieństwie do niektórych innych API, standardowa odpowiedź nie zawiera bezpośrednio maksymalnej długości okna kontekstu ani konkretnych cen. Informacje te należy pobrać z dokumentacji lub panelu. Endpoint ten jest jednak nieodzowny dla automatycznej konfiguracji klientów.

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

Użyj tego endpointu, aby dostosować aplikację do przyszłych zmian. Jeśli dodane zostaną nowe modele, pojawią się automatycznie na tej liście. Aktualny model uncensored to jedyny dostępny model, opisany jako duży model językowy zoptymalizowany pod treści bez cenzury.

Limity zapytań i kody błędów

Aby zapewnić stabilność usługi, obowiązują pewne limity. Na klucz API przypada limit 300 zapytań na minutę. Maksymalny rozmiar ciała żądania to 8 MB. Po przekroczeniu tych limitów otrzymasz kod statusu HTTP 429 Too Many Requests. Zaplanuj swoją aplikację tak, aby implementować ponawianie z wykładniczym backoffem.

Inne częste kody błędów to 401 Unauthorized przy nieprawidłowym kluczu API oraz 402 Payment Required przy wyczerpanym kredycie. KiApi używa modelu prepaid, więc zapytania bez środków są odrzucane natychmiast. Upewnij się, że regularnie sprawdzasz stan konta.

Okno kontekstu wynosi 100 000 tokenów dla wejścia i wyjścia łącznie. Przekroczenie tego limitu zwraca komunikat o błędzie. KiApi to niezawodne rozwiązanie dla programistów ceniących jasne zasady i przejrzyste limity.