API Dokumentation & Quickstart

Base URL og autentificering

Brug vores base URL og en enkelt API-nøgle til at oprette forbindelse. Endpointet accepterer standardheaders. Erstat YOUR_API_KEY med strengen fra dit dashboard.

• Base URL: https://api.ollamaopenaicompatibleapi.com/v1
• Model-ID: uncensored

Autentificeringen afhænger af et bearer-token. Send det i Authorization header. Dette sikrer kompatibilitet med ethvert OpenAI SDK-kompatibelt klientprogram. Du kan generere en ny nøgle øjeblikkeligt via Google eller e-mail. Der kræves ikke et telefonnummer.

Chat Completions Endpoint

Send en POST-forespørgsel til /v1/chat/completions. Inkluder din messages-array og modelnavn. API'et returnerer tekstoutput baseret på din prompt. Dette fungerer med enhver udbyder, der bruger standardparametre.

Indstil temperaturen for kreativitet, eller hold den lav for præcision. Du kan også definere stopsekvenser. Serveren behandler anmodningen og returnerer completion. Dette er den centrale interaktion for de fleste integrationer.

Husk, at fejl ikke forbruger din forudbetalte kredit. Kun succesfulde afslutninger faktureres. Dette beskytter dit budget under fejlfindingsfaser.

Copycurl https://api.ollamaopenaicompatibleapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the top 10 Linux kernel security patches from 2023"}]
  }'

Streaming-svar via SSE

Aktivér streaming ved at indstille stream: true. Serveren sender chunks, mens de genereres. Dette reducerer den opfattede latens betydeligt. Du modtager delvise svar i realtid.

Parser Server-Sent Events-strømmen. Den sidste chunk indeholder forbrugsstatistikker. Dette inkluderer tokenantal både for input og output. Du kan spore omkostninger dynamisk under genereringen.

Denne tilgang fungerer godt til chatgrænseflader. Brugere ser tekst dukke op ord for ord. Det føles mere responsivt end at vente på hele svaret. API'et håndterer forbindelsesstabiliteten automatisk.

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)

Function Calling og JSON-tilstand

Definer værktøjer i request-body'et. Modellen kan outputte strukturerede data. Brug response_format med {"type": "json_object"} til streng JSON. Dette sikrer parserbar output hver gang.

Værktøgsdefinitioner inkluderer navn, beskrivelse og parametre. Modellen beslutter, hvilket værktøj der skal kaldes. Du udfører funktionen og fodrer resultaterne tilbage. Dette muliggør komplekse agent-arbejdsgange.

JSON-tilstand deaktiverer fri tekstgenerering. Den tvinger modellen til at overholde dit schema. Brug dette, når du integrerer med databaser eller API'er. Det reducerer hallucination i strukturerede felter.

Copyfrom openai import OpenAI

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

Rate Limits og Anmodningskroppe

Du får 300 anmodninger i minuttet pr. nøgle. Concurrency er begrænset til 8 samtidige anmodninger. Den maksimale størrelse for request body er 8 MB. Dette passer til de fleste teksttung applikationer.

Kontekstvindue tillader i alt 100.000 tokens. Dette inkluderer både prompt og completion. Max output pr. anmodning er 16.000 tokens. Hvis du udelader max_tokens, det standardindstilles til 2.048.

Håndter HTTP 429-fejl pænt. De indikerer, at du ramte hastighedsbegrænsningen. Implementer eksponentiel backoff i din klientkode. Dette forhindrer, at serveren overbelastes under toppe.

Copyimport OpenAI from "openai";

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

Autentificeringsfejl og grænser

En 401-status betyder, at din nøgle er ugyldig. Tjek for tastefejl eller udløbte sessioner. En 402-status indikerer utilstrækkelig kredit. Oplad via krypto for at genoptage servicen.

En 429-status signalerer hastedsbegrænsning. Du har overskredet 300 anmodninger i minuttet. Reducer din throughput eller opgrader din nøgle. API'et returnerer klare fejlmeddelelser.

Kredit udløber aldrig. Du kan indbetale til enhver tid. Minimumsindbetaling er $20. Bonuskreditter gælder for større beløb. Dette holder dit projekt kørende smidigt.