Dokumentacja API Ollama dla programistów

Uwierzytelnianie i URL bazowy

Użyj https://api.ollamaendpointurl.com/v1 jako swój bazowy adres URL i uwzględnij swój klucz API w Authorization Nagłówek.

• Bazowy URL: https://api.ollamaendpointurl.com/v1
• Nagłówek: Authorization: Bearer YOUR_API_KEY

Wygeneruj swój klucz natychmiast przez Google lub e-mail na panelu. Nie jest wymagany numer telefonu. Ten URL działa z dowolnym standardowym SDK OpenAI poprzez nadpisanie adresu URL bazowego.

Pierwsze żądanie

Wyślij żądanie POST do /v1/chat/completions z identyfikatorem modelu uncensored i Twoje wiadomości.

Copycurl https://api.ollamaendpointurl.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "What is the default port for Ollama?"}]
  }'

To zwraca odpowiedź JSON zawierającą wygenerowany tekst. Jeśli otrzymasz błąd 401, Twój klucz API jest nieprawidłowy. Błąd 402 oznacza niewystarczający kredyt z góry.

Integracja SDK Python

Zainicjuj klienta, podając klucz oraz niestandardowy adres bazowy, aby wysyłać żądania programowo.

Copyfrom openai import OpenAI

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

Ustaw max_tokens do kontrolowania długości wyjścia; bez niego domyślna wartość to 2 048 tokenów. Model akceptuje standardowe parametry takie jak temperature i top_p do dostosowywania zachowania generacji.

Integracja SDK Node

Skonfiguruj klienta Node.js, aby wskazywał na nasz punkt końcowy dla seamless integracji w Twoje skrypty.

Copyimport OpenAI from "openai";

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

SDK automatycznie obsługuje serializację. Upewnij się, że używasz najnowszej wersji SDK OpenAI, która obsługuje niestandardowe adresy bazowe. Błędy są zgłaszane jako standardowe wyjątki API.

Odpowiedzi strumieniowe

Włącz strumieniowanie, ustawiając stream: true otrzymywania tokenów za pośrednictwem Server-Sent Events (SSE).

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)

Szczegóły zużycia tokenów pojawiają się w ostatnim fragmencie strumienia. Zmniejsza to postrzeganą latencję dla długich wyjść. Punkt końcowy obsługuje standardowe formatowanie SSE kompatybilne z większością bibliotek klienckich.

Limity szybkości i okno kontekstowe

Każdy klucz API jest ograniczony do 300 żądań na minutę i 8 żądań równoległych. Okno kontekstowe wynosi łącznie 100,000 tokenów. Maksymalna długość odpowiedzi na żądanie to 16,000 tokenów. Żądania z ciałem przekraczającym 8 MB są odrzucane. Błąd 429 oznacza, że osiągnąłeś limit szybkości. Poczekaj chwilę przed ponowną próbą. Błędy i odrzucenia nie pobierają kredytów. Kredyty nie wygasają. Doładuj środki za pomocą kryptowalut. Zacznij od kredytu próbnej wartości $0.50. Pobierz swój klucz teraz.