API Dokumentation

Bas URL och autentisering

API:en finns vid https://api.ollamaapidoc.com/v1. Du autentiserar med en Bearer-token i Authorization header. Generera din nyckel omedelbart via Google eller e-post på kontrollpanelen. Inget telefonnummer krävs. Nyckeln fungerar med standard OpenAI SDK:er genom att ange bas-URL:en.

Din första begäran

Skicka en POST-förfrågan till /v1/chat/completions med modell-ID:t uncensored. Denna slutpunkt hanterar textinmatning och textoutput. Den stöder strömning, JSON-läge och funktionsanrop. Du kan testa anslutningen utan att spendera kredit genom att kontrollera modellslutpunkten först.

Copycurl https://api.ollamaapidoc.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list all installed models"}]
  }'

Svaret returnerar standard OpenAI-formatering. Fel returnerar lämpliga HTTP-koder. Kontrollera kroppen för error detaljer om något misslyckas. Strömmade svar använder Server-Sent Events.

Python SDK-integration

Installera det officiella OpenAI-biblioteket. Konfigurera klienten med din bas-URL och API-nyckel. Anropa chat-slutpunkten för slutföranden. Koden förblir identisk med standardanvändning av OpenAI. Detta säkerställer enkel migration för befintliga projekt. Du kan justera parametrar som temperatur och top_p direkt i anropet.

Copyfrom openai import OpenAI

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

Hantera undantag för hastighetsbegränsningar eller ogiltiga nycklar. Biblioteket strömmar tokens om du ställer in stream till true. Detta håller din kodbas ren och kompatibel.

Node.js SDK-installation

Använd den openai npm-paket. Initiera klienten med den anpassade bas-URL:n. Ange din API-nyckel. Syntaxen speglar Python-exemplet. Denna konsekvens minskar felsökningstiden. Du kan skicka flera meddelanden i en konversationshistorik-array.

Copyimport OpenAI from "openai";

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

Analysera svaret noggrant. API:et returnerar strukturerad JSON. Felhantering är avgörande för produktionsappar. Fång nätverksfel och API-specifika fel separat. Detta säkerställer att din app förblir responsiv under hög trafik.

Streaming och JSON-läge

Aktivera strömning genom att ställa in stream parameter till true. API:et skickar tokens via Server-Sent Events. Du tar emot delvisa svar i realtid. Detta förbättrar användarupplevelsen för långa utdata. Du kan också tvinga fram JSON-utdata med response_format. Detta är användbart för extrahering av strukturerad data.

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 fungerar liknande. Definiera verktyg i din begäran. Modellen returnerar verktsanrop. Parsa dessa anrop i din kod. Exekvera dem och mata tillbaka resultat till modellen. Denna loop möjliggör komplexa arbetsflöden.

Gränser, fel och kontext

Kontextfönstret är 100 000 tokens. Max utdata är 16 000 tokens per begäran. Fel inkluderar 401 för ogiltiga nycklar och 402 för otillräcklig kredit. Hastighetsbegränsningar ligger på 300 begäranden per minut. Hantera dessa elegant i din app. API:et använder aldrig dina prompts för träning. Integriteten bevaras. Krediten löper inte ut.