Kimicode api-dokumentation

Bas URL och autentisering

Anslut till API:et med den angivna bas-URL:en och en förbetald token-nyckel. Du autentiserar genom att skicka din API-nyckel i begärans header, vilket säkerställer att endast ditt konto har tillgång till dina krediter. Registrera dig via Google eller e-post för att få din nyckel omedelbart utan telefonverifiering.

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

Dina begäranden riktar sig mot den standardiserade OpenAI-kompatibla slutpunkten. Denna design gör att du kan byta till vår tjänst utan att skriva om din befintliga klientkod, förutsatt att du uppdaterar bas-URL:en och inloggningsuppgifterna.

Slutpunkt för chattkomplettering

Skicka meddelanden till modellen med hjälp av POST /v1/chat/completions endpoint. Du måste ange modell-ID:t som uncensored till att komma/access den optimerade stora språkmodellen som körs på våra servrar. Systemet accepterar standardmeddelanderoller som användare eller assistent för flervändningssamtal.

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)

Denna slutpunkt hanterar textinmatning och returnerar genererad text. Den stöder inte embeddingar, bilder eller ljud. Fokusera på din promptstruktur för att få bästa resultat från den uncensored-modellen.

Strömningsresponser (SSE)

Aktivera realtidsleverans av tokens genom att ställa in stream-parametern till true i din begäran. API:et returnerar Server-Sent Events (SSE)-bitar, vilket gör att din applikation kan visa text medan den genereras. Den sista biten innehåller kompletta tokenanvändningsstatistik för fakturering.

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 minskar den upplevda latensen för slutanvändare. Du kan bearbeta varje token när den anländer, vilket är idealiskt för chattgränssnitt. Kom ihåg att streaming inte ändrar modellens underliggande beteende eller tokenprissättning.

Funktionsanrop och verktyg

Definiera verktyg i din begäran för att låta modellen returnera strukturerade funktionsanrop. API:t stöder tool_choice-parametrar, vilket gör att du kan tvinga modellen att använda ett specifikt verktyg eller låta den bestämma autonomt. Denna funktion fungerar med standard OpenAI-verktsformat, vilket gör integrationen enkel.

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

Använd funktionsanrop för att extrahera data eller utlösa åtgärder i dina applikationer. Modellen tolkar verktygsdefinitionerna och returnerar JSON-objekt som innehåller nödvändiga argument. Denna funktion utökar API:et bortom enkel textgenerering.

JSON-läge och parametrar

Tvinga strikt JSON-utdata genom att ställa in response_format för {"type": "json_object"}. Detta säkerställer att modellen returnerar giltig JSON, vilket är avgörande för programmatisk parsing. Du kan också justera parametrar som temperatur, top_p och stoppsekvenser för att kontrollera kreativitet och utdatalängd.

Modellen stöder ett kontextfönster på 100,000 tokens. Detta gör att du kan skicka stora mängder kontext i en enda begäran. Max utmatning är 16,000 tokens per begäran, eller 2,048 om du inte anger max_tokens.

Gränser, fel och kontext

Övervaka dina begäransgränser för att undvika tjänsteförsämring. API:t tillåter 300 begäranden per minut per nyckel och upp till 8 parallella begäranden. Din begäranskropp måste hålla sig under 8 MB. Om du överskrider dessa gränser får du ett 429-fel för hastighetsbegränsning.

Autentiseringsfel returnerar ett 401-fel om nyckeln är ogiltig. Ett 402-fel indikerar otillräckligt förbetalt kredit. Fel under generering konsumerar inte dina token. Kontextrutan inkluderar både prompt- och completion-token. Obetald kredit löper aldrig ut, vilket säkerställer att ditt förbetalda saldo förblir tillgängligt för framtida projekt.