Dokumentace API Kimicode

Základní URL a ověření

Připojte se k API pomocí poskytnuté základní URL a předplaceného klíče. Autentizujete se předáním svého API klíče v hlavičce požadavku, což zajišťuje, že pouze váš účet přistupuje k vašim kreditům. Zaregistrujte se přes Google nebo e-mail a získejte klíč okamžitě bez ověření telefonním číslem.

Copycurl https://api.kimicodeapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "What is the current rate limit for free tier users?"}]
  }'

Vaše požadavky cílí na standardní endpoint kompatibilní s OpenAI. Tento design umožňuje přepnout na naši službu bez přepisování kódu vašeho existujícího klienta, pokud aktualizujete základní URL a přihlašovací údaje.

Endpoint Chat Completions

Pošlete zprávy do modelu pomocí POST /v1/chat/completions endpoint. Musíte specifikovat ID modelu jako uncensored k přístupu k optimalizovanému velkému jazykovému modelu běžícímu na našich serverech. Systém přijímá standardní role zpráv, jako je user nebo assistant, pro víceotáčkové konverzace.

Copyfrom openai import OpenAI

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

Tento endpoint přijímá textový vstup a vrací vygenerovaný text. Nepodporuje vektory, obrázky ani audio. Zaměřte se na strukturu promptu, abyste získali nejlepší výsledky z modelu bez omezení.

Streamované odpovědi (SSE)

Povolte doručování tokenů v reálném čatu nastavením parametru stream na true v požadavku. API vrací části Server-Sent Events (SSE), což umožňuje vaší aplikaci zobrazovat text během jeho generování. Poslední část obsahuje kompletní statistiky využití tokenů pro fakturaci.

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)

Streaming snižuje vnímanou latenci pro koncové uživatele. Můžete zpracovávat každý token, jak přichází, což je ideální pro chatová rozhraní. Pamatujte, že streaming nemění chování modelu ani cenovou politiku tokenů.

Volání funkcí a nástroje

Definujte nástroje v těle žádosti, abyste umožnili modelu výstupovat strukturovaná volání funkcí. API podporuje parametry tool_choice, což vám umožňuje vynutit použití konkrétního nástroje modelem nebo nechat ho rozhodnout autonomně. Tato funkce funguje se standardními formáty nástrojů OpenAI, což zjednodušuje integraci.

Copyimport OpenAI from "openai";

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

Používejte volání funkcí k extrakci dat nebo spouštění akcí ve vašich aplikacích. Model interpretuje definice nástrojů a vrací JSON objekty obsahující potřebné argumenty. Tato možnost rozšiřuje API beyond jednoduchou generaci textu.

Režim JSON a parametry

Vynucujte přísný výstup JSON nastavením response_format na {"type": "json_object"}. To zajišťuje, že model vrací platný JSON, což je zásadní pro programové parsování. Můžete také upravit parametry, jako je teplota, top_p a sekvence stop, a ovládat tak kreativitu a délku výstupu.

Model podporuje kontextové okno o velikosti 100 000 tokenů. To vám umožňuje předat velké množství kontextu v jednom požadavku. Maximální výstup je 16 000 tokenů na požadavek, nebo 2 048, pokud nezadáte max_tokens.

Limity, chyby a kontext

Sledujte své limity požadavků, abyste předešli přerušení služby. API umožňuje 300 požadavků za minutu na klíč a až 8 souběžných požadavků. Tělo vašeho požadavku musí být menší než 8 MB. Pokud tyto limity překročíte, obdržíte chybu omezení rychlosti 429.

Selhání ověření vrací chybu 401, pokud je klíč neplatný. Chyba 402 naznačuje nedostatek předplaceného kreditu. Chyby během generování nespotřebovávají vaše tokeny. Kontextové okno zahrnuje tokeny promptu i dokončení. Nepoužitý kredit nikdy nevyprší, což zajišťuje, že váš předplacený zůstatek zůstane k dispozici pro budoucí projekty.