API Dokumentace

Základní URL a ověření

API žije na https://api.ollamaapidoc.com/v1. Ověřujete platnost pomocí Bearer tokenu v Authorization hlavička. Vygenerujte si klíč okamžitě přes Google nebo e-mail v ovládacím panelu. Není vyžadováno telefonní číslo. Klíč funguje se standardními SDK OpenAI nastavením základní URL.

Váš první požadavek

Odeslat požadavek POST na /v1/chat/completions pomocí ID modelu uncensored. Tento endpoint zpracovává textový vstup a výstup. Podporuje streamování, režim JSON a volání funkcí. Připojení můžete otestovat bez spotřeby kreditu nejdříve ověřením endpointu modelů.

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

Odpověď vrací standardní formát OpenAI. Chyby vracejí příslušné HTTP kódy. Zkontrolujte tělo pro error podrobnosti, pokud něco selže. Streamované odpovědi používají Server-Sent Events.

Integrace Python SDK

Nainstalujte oficiální knihovnu OpenAI. Nakonfigurujte klienta svou základní URL a API klíčem. Zavolejte endpoint chat completions. Kód zůstává identický se standardním použitím OpenAI. To zajišťuje snadný přechod pro existující projekty. Parametry, jako jsou teplota a top_p, můžete upravit přímo v volání.

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)

Ošetřete výjimky pro limity rychlosti nebo neplatné klíče. Knihovna streamuje tokeny, pokud nastavíte stream na true. Tento přístup udržuje váš kód čistý a kompatibilní.

Nastavení SDK Node.js

Použijte openai npm package. Initialize the client with the custom base URL. Pass your API key. The syntax mirrors the Python example. This consistency reduces debugging time. You can send multiple messages in a conversation history array.

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

Parsovejte odpověď pečlivě. API vrací strukturovaný JSON. Zpracování chyb je zásadní pro produkční aplikace. Chyby sítě a chyby specifické pro API zachyťte odděleně. To zajistí, že vaše aplikace zůstane responzivní při vysoké zátěži.

Streamování a režim JSON

Povolte streamování nastavením stream parameter na true. API odesílá tokeny prostřednictvím Server-Sent Events. Částečné odpovědi přijímáte v reálném čase. To zlepšuje uživatelský zážitek u dlouhých výstupů. Pomocí můžete také vynutit výstup ve formátu JSON response_format. To je užitečné pro extrakci strukturovaných dat.

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)

Volání funkcí funguje podobně. Definujte nástroje ve svém požadavku. Model vrátí volání nástrojů. Parsovejte tato volání ve svém kódu. Proveďte je a výsledky vraťte modelu. Tento cyklus umožňuje složité pracovní postupy.

Limity, chyby a kontext

Okno kontextu má 100 000 tokenů. Maximální výstup je 16 000 tokenů na požadavek. Chyby zahrnují 401 pro neplatné klíče a 402 pro nedostatečný kredit. Limity rychlosti omezují na 300 požadavků za minutu. Řiďte je slušně ve své aplikaci. API nikdy nepoužívá vaše prompty pro trénink. Soukromí je zachováno. Kredit nevyprší.