Character api Integration Quickstart

Installera SDK:et

Börja med att installera det officiella klientbiblioteket för ditt språk. Detta säkerställer kompatibilitet med den OpenAI-kompatibla slutpunkt vi tillhandahåller. Biblioteket hanterar serialisering och logik för omförsök åt dig.

För Python, använd pip. För Node.js, använd npm. Detta steg tar några sekunder och ställer in miljön för kodproven som följer.

Konfigurera din bas-URL

Pek SDK-klienten mot vår slutpunkt för att få tillgång till den obegränsade modellen. Bas-URL:n är HTTPS://api.apicharacter.com/v1. Detta ersätter standard OpenAI-URL:n i din konfiguration.

Utan denna ändring kommer begäranden att misslyckas eller träffa fel tjänst. Du behöver bara ställa in detta en gång när du initierar din klientinstans.

Ställ in din API-nyckel

Infoga din nyckel i miljövariabeln eller klientkonfigurationen. Autentisering krävs för varje begäran för att spåra din förbetala kreditanvändning. Din nyckel ger tillgång till osensurerade LLM-slutpunkten.

Spara detta värde säkert. Det fungerar som ditt enda autentiseringsmedel för kontot. Inget telefonnummer eller ytterligare verifiering krävs för grundläggande åtkomst.

Gör din första förfrågan

Skicka en enkel chatcompletion för att verifiera anslutning. Modell-ID:t är "uncensored". Detta bekräftar att din autentisering och bas-URL är korrekta innan du bygger din applikation.

Se exemplet nedan för en standard cURL-förfrågan.

Copycurl https://api.apicharacter.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "set my name to Alex"}]
  }'

Hantera Streaming-svar

Aktivera strömning för lägre latens i dina gränssnitt för chatt. Ställ in stream-parametern till true i din begäran. SDK:et kommer att yielda tokens när de genereras.

Detta är kritiskt för responsiva användarupplevelser. Du hanterar de partiella bitarna när de anländer via Server-Sent Events.

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)

Gränser, fel och kontext

Förstå dina begränsningar för att undvika tjänstestörningar. Du får ett kontextfönster på 100 000 tokens. Max utmatning är 16 000 tokens om du inte anger annat.

Gränsen är 300 begäranden per minut. Ett 401-fel betyder ogiltig nyckel. Ett 402-fel betyder noll kredit. Ett 429-fel betyder att du har nått gränsen. Håll detta i minnet för skalning i produktion.

Python

Copyfrom openai import OpenAI

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

Node.js

Copyimport OpenAI from "openai";

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