API-dokumentation & snabbstart

Bas URL och autentisering

Använd vår bas-URL och en enda API-nyckel för att ansluta. Slutpunkten accepterar standardhuvuden. Ersätt YOUR_API_KEY med strängen från ditt dashboard.

• Bas-URL: https://api.ollamaopenaicompatibleapi.com/v1
• Modell-ID: uncensored

Autentiseringen bygger på en bearer-token. Skicka den i Authorization header. Detta säkerställer kompatibilitet med valfri OpenAI SDK-kompatibel klient. Du kan generera en ny nyckel omedelbart via Google eller e-post. Inget telefonnummer krävs.

Slutpunkt för chattkomplettering

Skicka en POST-förfrågan till /v1/chat/completions. Ange din messages-array och modellnamn. API:et returnerar textutdata baserat på din prompt. Detta fungerar med alla leverantörer som använder standardparametrar.

Ställ in temperaturen för kreativitet eller håll den låg för precision. Du kan också definiera stoppsekvenser. Servern bearbetar begäran och returnerar slutförandet. Detta är den grundläggande interaktionen för de flesta integrationer.

Kom ihåg att fel inte förbrukar din förbetalda kredit. Endast lyckade kompletteringar debiteras. Detta skyddar din budget under felsökningsfaser.

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

Strömningsresponser via SSE

Aktivera strömning genom att ställa in stream: true. Servern skickar chunkar när de genereras. Detta minskar uppfattad latens avsevärt. Du tar emot delvisa svar i realtid.

Analysera Server-Sent Events-strömmen. Den sista biten innehåller användningsstatistik. Detta inkluderar tokenräkningar för både inmatning och utmatning. Du kan spåra kostnader dynamiskt under genereringen.

Denna metod fungerar bra för chattgränssnitt. Användare ser text dyka upp ord för ord. Det känns mer responsivt än att vänta på hela svaret. API:t hanterar anslutningsstabiliteten automatiskt.

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)

Funktionsanrop och JSON-läge

Definiera verktyg i din begärans kropp. Modellen kan returnera strukturerad data. Använd response_format med {"type": "json_object"} för strikt JSON. Detta säkerställer parsbar utdata varje gång.

Verktygsdefinitioner inkluderar namn, beskrivning och parametrar. Modellen bestämmer vilket verktyg som ska anropas. Du utför funktionen och matar tillbaka resultat. Detta möjliggör komplexa agentflöden.

JSON-läge inaktiverar fri textgenerering. Det tvingar modellen att följa ditt schema. Använd detta när du integrerar med databaser eller API:er. Det minskar hallucinationer i strukturerade fält.

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)

Begränsningar för begäranderänta och begäranderubriker

Du får 300 förfrågningar per minut per nyckel. Konkurrensen är begränsad till 8 samtidiga förfrågningar. Maximal storlek på request body är 8 MB. Detta passar de flesta texttunga applikationer.

Kontextrutan tillåter 100 000 tokens totalt. Detta inkluderar både prompt och komplettering. Max utmatning per begäran är 16 000 tokens. Om du utelämnar max_tokens, det är 2 048 som standard.

Hantera HTTP 429-fel elegant. De indikerar att du träffade hastighetsbegränsningen. Implementera exponentiell backoff i din klientkod. Detta förhindrar att servern överbelastas under toppar.

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

Autentiseringsfel och begränsningar

En 401-status betyder att din nyckel är ogiltig. Kontrollera stavfel eller utgångna sessioner. En 402-status indikerar otillräcklig kredit. Ladda upp via krypto för att återuppta tjänsten.

En 429-status signalerar hastighetsbegränsning. Du överskred 300 förfrågningar per minut. Minska din genomströmning eller uppgradera din nyckel. API:et returnerar tydliga felmeddelanden.

Krediten löper inte ut. Du kan fylla på när som helst. Minsta påfyllning är $20. Bonuskrediter tillämpas för större belopp. Detta håller ditt projekt igång smidigt.