Dokumentacja API Ollama: Referencja endpointów

Bazowy URL i autoryzacja

Podstawowy adres URL dla wszystkich żądań to https://api.ollamaapidocumentation.com/v1. Uwierzytelniasz się za pomocą tokena bearer przekazanego w Authorization Nagłówek. Twój klucz jest generowany na panelu i działa natychmiast.

• Korzystaj z oficjalnych bibliotek OpenAI lub dowolnego kompatybilnego klienta.
• Ustaw URL bazowy na wartość powyżej.
• Dołącz swój klucz API do nagłówka.

Uwierzytelnianie jest ścisłe. Jeśli klucz jest nieobecny lub nieprawidłowy, API zwraca błąd 401. Gwarantuje to dokładne śledzenie zużycia do celów rozliczeniowych.

Punkt końcowy Uzupełnień Czat: POST /v1/chat/completions

Wyślij wiadomości do modelu poprzez POST /v1/chat/completions. Punkt końcowy akceptuje ciało JSON z model pole ustawione na "uncensored" i messages tablicę.

Ten punkt końcowy obsługuje generację tekstu. Nie obsługuje obrazów, audio ani wideo. Możesz strumieniować odpowiedzi lub czekać na pełny wynik.

Błędy takie jak 402 wskazują na niewystarczające środki. Żądania są rozliczane na podstawie rzeczywistego zużycia tokenów. Odrzucenia spowodowane brakiem środków są darmowe.

Lista modeli: GET /v1/models

Pobierz dostępne modele za pomocą GET /v1/modelsTo zwraca listę obiektów modeli. Dostępny jest tylko jeden identyfikator modelu: "uncensored".

Ten punkt końcowy pomaga zweryfikować łączność. Potwierdza, że adres bazowy jest poprawny. Pokazuje również nazwę modelu i typ obiektu.

Użyj tego, aby debugować problemy z połączeniem przed wysłaniem dużych ładunków.

Parametry: Temperatura, Top P, Seed

Kontroluj generowanie za pomocą temperature, top_p, a także seed. API seed parameter zapewnia deterministyczne wyniki. Użyj go do debugowania lub spójnych wyników.

Ustaw temperature między 0 a 2. Niższe wartości sprawiają, że odpowiedzi są bardziej przewidywalne. Wyższe wartości zwiększają losowość. The top_p parametr filtruje tokeny według prawdopodobieństwa kumulacyjnego.

Te parametry działają dokładnie jak API OpenAI. Możesz łączyć je dla precyzyjnej kontroli nad stylem.

Odpowiedzi strumieniowe i zużycie tokenów

Włącz strumieniowanie, ustawiając stream: true. API zwraca zdarzenia wysłane przez serwer (SSE). Każdy fragment zawiera częściowy tekst.

Ostatni fragment zawiera statystyki użycia tokenów. Pozwala to dokładnie obliczyć koszty. Możesz przetwarzać tokeny w miarę ich napływania.

Strumieniowanie zmniejsza postrzeganą latencję. Jest idealne dla interfejsów czatu. Serwer wysyła dane, aż odpowiedź będzie kompletna.

Limity, Błędy i Okno Kontekstu

Okno kontekstowe wynosi 100 000 tokenów. Obejmuje ono razem tokeny wejściowe i wyjściowe. Możesz wygenerować do 16 000 tokenów w jednym żądaniu. Domyślna maksymalna długość odpowiedzi to 2 048 tokenów.

Limity szybkości to 300 żądań na minutę. Możesz wysyłać 8 żądań współbieżnych. Rozmiar ciała żądania jest ograniczony do 8 MB.

Błędy obejmują kod 401 dla nieprawidłowych kluczy oraz 429 dla limitów szybkości. Błędy związane z kreditem zwracają kod 402. Te błędy są jasne i pozwalają na podjęcie działań.

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

Strumieniowanie

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)