Dokumentace k API: Kompatibilní koncové body OpenAI-Compatible

Ověření & základní URL

Přistupujte k API nastavením svého jedinečného klíče a základní URL ve vašich proměnných prostředí. Endpoint se nachází na https://api.apikeykimi.com/v1. Musíte zahrnout hlavičku Authorization: Bearer YOUR_API_KEY s každým požadavkem. Tento klíč je vygenerován okamžitě po registraci přes Google nebo e-mail. Je to jediný potřebný údaj pro autentizaci. Žádné rozsahy ani oprávnění není třeba konfigurovat.

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

Endpoint Chat Completions

Pošlete zprávy do modelu pomocí standardního /v1/chat/completions endpoint. Specifikujte ID modelu jako uncensored v těle požadavku. API vrací vygenerovaný text na základě historie vašich promptů. Můžete upravit parametry, jako je teplota a top_p, pro ovládání kreativity. Model podporuje volání funkcí a JSON režim pro strukturované výstupy.

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)

Streamované odpovědi (SSE)

Povolit doručování tokenů v reálném čase nastavením stream: true ve vaší žádosti. Server vrací stream Server-Sent Events. Každý chunk obsahuje částečný text, dokud není odpověď kompletní. Je to ideální pro chatová rozhraní a živá zobrazení kódu. Detaily o využití tokenů se objevují v posledním chunku streamu.

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)

Volání funkcí & Režim JSON

Definujte nástroje nebo vynutte výstup ve formátu JSON pomocí response_format parametr. Nastavte json_object aby byly zajištěny platné odpovědi JSON. Můžete také předat definice nástrojů pro volání funkcí. Model se těmto omezením přísně podřizuje. To umožňuje spolehlivou integraci s externími službami. Použijte tool_choice ovlivnit, jak jsou nástroje vyvolávány.

Limity tokenů & Omezení

Okno kontextu podporuje až 100 000 tokenů pro vstup a výstup dohromady. Maximální výstup na požadavek je 16 000 tokenů. Pokud nenastavíte max_tokens, limit se výchozím způsobem rovná 2 048 tokenům. Požadavky jsou omezeny na velikost těla 8 MB. Máte limit 300 požadavků za minutu. Pouze 8 požadavků může běžet současně na klíč.

Zpracování chyb & Limity využití

Zpracujte chyby kontrolou HTTP status kódu. 401 označuje neplatný nebo expirovaný API klíč. Chyba 402 znamená, že je vyčerpán váš předplacený kredit. Odpověď 429 signalizuje, že jste překročili limit rychlosti 300 požadavků za minutu. Chyby i odmítnutí nespotřebovávají tokeny. Sledujte svůj zůstatek na panelu, abyste předešli přerušením.

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