Ollama API-dokumentation: Snabbstartsguide
Den här guiden ger de konkreta detaljerna för vårt OpenAI-kompatibla API, vilket gör att du kan byta ut vår obegränsade modell utan att ändra din befintliga klientkod.
Bas URL och autentisering
Den basala URL:en är HTTPS://api.ollamaapidocs.com/v1. Skicka din nyckel i standard Authorization-headern.
curl https://api.ollamaapidocs.com/v1/chat/completions \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [{"role": "user", "content": "List installed models in the local directory"}]
}'
Slutpunkt för chattkomplettering
Skicka POST-begäranden till /v1/chat/completions med modellen inställd på obegränsad.
from openai import OpenAI
client = OpenAI(base_url="https://api.ollamaapidocs.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)
Strömning och verktygsstöd
Aktivera strömning genom att ställa in stream till true. API:et returnerar tokens via Server-Sent Events och stöder function calling.
stream = 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)
JSON-läge och parametrar
Använd response_format json_object för strikt JSON-output. Du kan också justera temperatur, top_p och stoppsekvenser.
import OpenAI from "openai";
const client = new OpenAI({ baseURL: "https://api.ollamaapidocs.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);
Begränsningar för begäranderänta och begränsningar
Gränsen är 300 begäranden per minut per nyckel. Varje begäran stöder ett kontextfönster på 100 000 tokens.
curl https://api.ollamaapidocs.com/v1/chat/completions \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [{"role": "user", "content": "List installed models in the local directory"}]
}'
Fel och kontextfönster
Hantera 401 för ogiltiga nycklar, 402 för inget kredit och 429 för hastighetsbegränsningar. Modellen stöder ett kontextfönster på 100,000 tokens.
from openai import OpenAI
client = OpenAI(base_url="https://api.ollamaapidocs.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)Vanliga frågor
Vad är ollama API-dokumentationen för denna tjänst?
Den här guiden täcker bas-URL:n, autentiseringen och slutpunkterna för vårt värdade API. Det gör att du kan använda standard OpenAI SDK:er med vår obegränsade modell.
Hur hanterar jag strömnings-svar?
Ställ in stream-parametern till true i din förfrågan. API:et returnerar tokens via Server-Sent Events, vilket möjliggör realtidsbearbetning.
Vad händer om jag överskrider hastighetsbegränsningen?
Du får statuskoden 429. Gränsen är 300 förfrågningar per minut per nyckel, med maximalt 8 parallella förfrågningar.
Generera din API-nyckel
Registrera dig, kopiera din nyckel och uppdatera din bas-URL:en. Det är allt du behöver för att komma igång.