Dokumentace API pro vývojáře

Základní URL a ověření

Základní URL je HTTPS://api.ollamaapiurl.com/v1. Přihlášení provedete předáním svého unikátního klíče API v hlavičce Authorization. Tento klíč slouží jako vaše pověření pro všechny požadavky. Získejte jej z panelu ihned po registraci.

• "Chraňte svůj klíč. Poskytuje plný přístup k vašemu předplacenému kreditu."
• Vygenerujte nový klíč kdykoli na stránce nastavení.

Systém našich klíčů API je jednoduchý. Jeden aktivní klíč na účet zajišťuje jasné sledování. Pokud ztratíte přístup, okamžitě jej obnovte. Žádné ověření telefonním číslem vám nebrání v přístupu.

První požadavek

Pošlete svůj první prompt pomocí standardního HTTP. Endpoint přijímá textový vstup a vrací textový výstup. Tato metoda funguje s libovolnou knihovnou HTTP klienta, kterou preferujete.

Copycurl https://api.ollamaapiurl.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List all available models in the local library"}]
  }'

Odpověď obsahuje využití tokenů. Platíte pouze za zpracované tokeny. Chyby nespotřebují váš předplacený zůstatek. Tato transparentnost vám umožňuje přesně kontrolovat své výdaje.

Integrace Python SDK

Použijte oficiální knihovnu OpenAI pro Python. Směrujte ji na naši základní URL. Nastavte ID modelu na uncensored. To zajišťuje chování bez cenzury bez starostí s lokálním nastavením.

Copyfrom openai import OpenAI

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

Knihovna automaticky zvládá opakování a formátování. Dostanete strukturovaný JSON nebo surový text. Streamování je také podporováno. Tento přístup udržuje váš kód čistý a udržovatelný.

Nastavení SDK pro Node

Nainstalujte balíček openai. Nakonfigurujte základní URL tak, aby ukazovala na naši službu. Nastavte API klíč z vašeho prostředí. Toto nastavení úzce kopíruje konfiguraci Pythonu.

Copyimport OpenAI from "openai";

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

Vývojáři Node získávají konzistentní chování. Model reaguje na podněty okamžitě. Můžete jej integrovat do jakéhokoli webového serveru nebo pracovního procesu na pozadí. Není třeba složité logiky směrování.

Streamované odpovědi

Povolte streamování nastavením stream na true. API vrací chunky, jak jsou generovány. To zlepšuje vnímanou latenci pro uživatele. Tokeny můžete zobrazovat, jak se objevují.

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)

Poslední blok obsahuje celkový počet tokenů. Použijte jej pro ověření fakturace. Streamování funguje se všemi parametry. Podporuje také volání funkcí. Vaši uživatelé vidí postup v reálném čase.

Limity, chyby a kontext

Váš kontextový okno sahá na 100 000 tokenů celkem. To zahrnuje jak prompt, tak dokončení. Můžete vygenerovat až 16 000 tokenů na požadavek. Limit rychlosti umožňuje 300 požadavků za minutu. Souběžné požadavky jsou omezeny na osm na klíč.

Mezi běžné chyby patří 401 pro neplatné klíče. Chyba 402 znamená, že je vyčerpán váš předplacený kredit. Odpověď 429 signalizuje, že jste dosáhli limitu rychlosti. Zkontrolujte svůj ovládací panel pro dobíjení pomocí kryptoměn. Kredity nikdy nevyprší. Chyby, jako jsou dvojí účty, se opravují přes podporu.