Dokumentacja API: OpenAI-Compatible Endpoints

Uwierzytelnianie & URL bazowy

Skorzystaj z API, ustawiając swój unikalny klucz i bazowy URL w zmiennych środowiskowych. Endpoint znajduje się pod adresem https://api.apikeykimi.com/v1. Musisz dołączyć nagłówek Authorization: Bearer YOUR_API_KEY z każdym żądaniem. Ten klucz jest generowany natychmiast po rejestracji za pomocą Google lub e-maila. Jest to jedyne poświadczenie wymagane do uwierzytelnienia. Nie ma potrzeby konfigurowania zakresów ani uprawnień.

Copycurl https://api.apikeykimi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "convert this json object to python dictionary syntax"}]
  }'

Punkt końcowy Uzupełnień Czat

Wyślij wiadomości do modelu za pomocą standardowego /v1/chat/completions endpoint. Określ identyfikator modelu jako uncensored w ciele żądania. API zwraca wygenerowany tekst na podstawie historii promptów. Możesz dostosować parametry takie jak temperatura i top_p, aby kontrolować kreatywność. Model obsługuje wywoływanie funkcji i tryb JSON dla danych strukturalnych.

Copyfrom openai import OpenAI

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

Odpowiedzi strumieniowe (SSE)

Włącz dostarczanie tokenów w czasie rzeczywistym, ustawiając stream: true w Twoim żądaniu. Serwer zwraca strumień Zdarzeń Wysyłanych przez Serwer. Każdy chunk zawiera częściowy tekst, dopóki odpowiedź nie będzie kompletna. Jest to idealne dla interfejsów czatu i wyświetlania kodu na żywo. Szczegóły dotyczące użycia tokenów pojawiają się w ostatnim chunku strumienia.

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)

Wywoływanie funkcji & Tryb JSON

Zdefiniuj narzędzia lub wymuś output w formacie JSON za pomocą response_format parametr. Ustaw json_object aby zapewnić poprawne odpowiedzi w formacie JSON. Możesz również przekazać definicje narzędzi do wywoływania funkcji. Model ściśle przestrzega tych ograniczeń. Pozwala to na niezawodną integrację z usługami zewnętrznymi. Użyj tool_choice kontrolować, jak są wywoływane narzędzia.

Limity tokenów & Ograniczenia

Okno kontekstowe obsługuje do 100 000 tokenów dla danych wejściowych i wyjściowych łącznie. Maksymalna ilość wyjściowa na żądanie wynosi 16 000 tokenów. Jeśli nie ustawisz max_tokens, limit domyślnie wynosi 2 048 tokenów. Żądania są ograniczone do 8 MB w rozmiarze ciała. Jesteś ograniczony do 300 żądań na minutę. Tylko 8 żądań może działać jednocześnie na klucz.

Obsługa błędów & Limity użytkowania

Obsłuż błędy, sprawdzając kod statusu HTTP. Status 401 wskazuje na nieprawidłowy lub wygasły klucz API. Błąd 402 oznacza, że Twoje prepaydowane środki zostały wyczerpane. Odpowiedź 429 sygnalizuje, że przekroczyłeś limit szybkości wynoszący 300 żądań na minutę. Błędy i odmowy nie zużywają tokenów. Sprawdź swoje saldo na panelu, aby uniknąć przerw.

Node.js

Copyimport OpenAI from "openai";

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