Ollama API-dokumentation: Endpunktsreference

Base URL og autentificering

Base-URL'en til alle anmodninger er https://api.ollamaapidocumentation.com/v1. Du autentificerer ved hjælp af en bearer-token, der sendes i Authorization header. Din nøgle genereres på dashboardet og fungerer med det samme.

• Brug de officielle OpenAI SDKs eller ethvert kompatibelt klientbibliotek.
• Indstil base URL til værdien ovenfor.
• Indsæt din API-nøgle i headeren.

Autentificeringen er streng. Hvis nøglen mangler eller er ugyldig, returnerer API'et en 401-fejl. Dette sikrer, at dit forbrug spores nøjagtigt til fakturering.

Chat Completions Endpoint: POST /v1/chat/completions

Send beskeder til modellen via POST /v1/chat/completions. Endpointet accepterer en JSON-krop med en model felt sat til "uncensored" og en messages array.

Dette endpoint håndterer tekstgenerering. Det understøtter ikke billeder, lyd eller video. Du kan streame svar eller vente på det fulde resultat.

Fejl som 402 indikerer utilstrækkelig kredit. Anmodninger opkræves efter reel tokenbrug. Afvisninger på grund af kredit er gratis.

Modelopstilling: GET /v1/models

Hent tilgængelige modeller ved hjælp af GET /v1/models. Dette returnerer en liste over model-objekter. Den eneste tilgængelige model-ID er "uncensored".

Dette endpoint hjælper med at verificere forbindelsen. Det bekræfter, at base URL er korrekt. Det viser også modelnavn og objekttype.

Brug dette til at fejlsøge forbindelsesproblemer, før du sender tunge payloads.

Parametre: Temperatur, Top P og Seed

Styr genereringen med temperature, top_p, og seedThe seed parameter sikrer deterministiske output. Brug den til fejlfinding eller konsistente resultater.

Indstil temperature mellem 0 og 2. Lavere værdier gør svar mere forudsigelige. Højere værdier øger tilfældigheden. Den top_p parameter filtrerer tokens efter kumulativ sandsynlighed.

Disse parametre fungerer præcis som OpenAI API. Du kan kombinere dem for præcis kontrol over stilen.

Streaming-svar og tokenforbrug

Aktivér streaming ved at indstille stream: true. API'et returnerer Server-Sent Events (SSE). Hver chunk indeholder delvis tekst.

Den sidste chunk indeholder tokenbrugsstatistikker. Dette giver dig mulighed for at beregne omkostninger præcist. Du kan behandle tokens, mens de ankommer.

Streaming reducerer den opfattede forsinkelse. Det er ideelt til chatgrænseflader. Serveren sender data, indtil svaret er fuldt ud færdigt.

Begrænsninger, fejl og kontekstvindue

Kontekstvinduet er på 100.000 tokens. Dette inkluderer både input og output. Du kan generere op til 16.000 tokens pr. request. Det standardmæssige maks output er 2.048 tokens.

Ratebegrænsningen er 300 requests i minuttet. Du kan have 8 samtidige requests. Størrelsen på request-bodyn er begrænset til 8 MB.

Fejl inkluderer 401 for ugyldige nøgler og 429 for hastighedsgrænser. Kreditfejl returnerer 402. Disse fejl er klare og handlingsbare.

cURL

Copycurl https://api.ollamaapidocumentation.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list files in the current directory"}]
  }'

Python

Copyfrom openai import OpenAI

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

Streaming

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)