API Dokumentacja

Bazowy URL i autoryzacja

API żyje w https://api.ollamaapidoc.com/v1. Uwierzytelniasz się za pomocą tokena Bearer w Authorization Nagłówek. Wygeneruj swój klucz natychmiast za pomocą Google lub e-maila w panelu. Nie jest wymagany numer telefonu. Klucz działa ze standardowymi pakietami SDK OpenAI poprzez ustawienie podstawowego adresu URL.

Twoje Pierwsze Żądanie

Wyślij żądanie POST do /v1/chat/completions z identyfikatorem modelu uncensored. Ten endpoint obsługuje wejście tekstowe i wyjście tekstowe. Obsługuje strumieniowanie, tryb JSON i wywoływanie funkcji. Możesz przetestować łączność nie wydając kredytu, sprawdzając najpierw endpoint modeli.

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

Odpowiedź zwraca standardowe formatowanie OpenAI. Błędy zwracają odpowiednie kody HTTP. Sprawdź treść pod kątem error szczegóły w przypadku błędu. Odpowiedzi strumieniowe używają Event Stream Serwerów (SSE).

Integracja SDK Python

Zainstaluj oficjalną bibliotekę OpenAI. Skonfiguruj klienta swoim adresem bazowym i kluczem API. Wywołaj endpoint chat completions. Kod pozostaje identyczny jak w standardowym użyciu OpenAI. Zapewnia to łatwą migrację dla istniejących projektów. Możesz dostosować parametry, takie jak temperatura i top_p, bezpośrednio w wywołaniu.

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)

Obsługuj wyjątki dla limitów szybkości lub nieprawidłowych kluczy. Biblioteka strumieniuje tokeny, jeśli ustawisz stream na true. To podejście utrzymuje czystość kodu i kompatybilność.

Konfiguracja SDK Node.js

Korzystaj z openai pakiet npm. Zainicjuj klienta z niestandardowym URL bazowym. Przekaż swój klucz API. Składnia odzwierciedla przykład w Pythonie. Ta spójność skraca czas debugowania. Możesz wysyłać wiele wiadomości w tablicy historii rozmowy.

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

Przeanaluj odpowiedź dokładnie. API zwraca strukturyzowany JSON. Obsługa błędów jest kluczowa dla aplikacji produkcyjnych. Łap błędy sieciowe i błędy specyficzne dla API osobno. Zapewnia to, że Twoja aplikacja pozostaje responsywna przy dużym ruchu.

Strumieniowanie i tryb JSON

Włącz strumieniowanie, ustawiając stream ustaw na true. API wysyła tokeny za pośrednictwem zdarzeń wysłanych przez serwer. Otrzymujesz częściowe odpowiedzi w czasie rzeczywistym. Poprawia to doświadczenie użytkownika dla długich wyników. Możesz również wymusić wynik JSON za pomocą response_format. Jest to przydatne do ekstrakcji danych strukturalnych.

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)

Wywoływanie funkcji działa podobnie. Zdefiniuj narzędzia w swoim żądaniu. Model zwraca wywołania narzędzi. Sparsuj te wywołania w swoim kodzie. Wykonaj je i przekaż wyniki z powrotem do modelu. Ta pętla umożliwia złożone przepływy pracy.

Limity, Błędy i Kontekst

Okno kontekstowe wynosi 100 000 tokenów. Maksymalny output to 16 000 tokenów na żądanie. Błędy obejmują 401 dla nieprawidłowych kluczy i 402 za niewystarczający kredyt. Limity szybkości wynoszą 300 żądań na minutę. Obsługuj je graceful w swojej aplikacji. API nigdy nie używa Twoich promptów do trenowania. Prywatność jest zachowana. Kredyt nie wygasa.