Dokumentace API OpenRouter

Rychlý start: Připojení pomocí Pythonu

Začněte instalací oficiálního SDK a nasměrujte jej na naši základní URL.

Naše API se chová jako standardní rozhraní OpenAI, ale směruje požadavky k jednomu uncensored modelu. Tento přístup eliminuje složitost proxy, zatímco udržuje přenositelnost vašeho kódu.

• Nainstalujte knihovnu pomocí pip.
• Nastavte svůj klíč API v prostředí.
• Definujte základní URL pro náš endpoint.

Copyfrom openai import OpenAI

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

Nahraďte zástupný klíč svými vlastními přihlašovacími údaji. Můžete odesílat jednoduché dotazy nebo komplexní strukturovaná data.

Ověření a klíče

Vygenerujte klíč na dashboardu a předáte ho v hlavičce Authorization.

Každý účet podporuje jeden aktivní klíč najednou. Když vytvoříte nový klíč, starý okamžitě přestane fungovat. To zjednodušuje správu zabezpečení bez nutnosti složité logiky rotace.

Copycurl https://api.apiopenrouter.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the top 5 dependencies for a Go web server"}]
  }'

Výše uvedená žádost používá schéma Bearer. Ujistěte se, že váš klíč začíná na sk- a neobsahuje žádný nadbytečný whitespace.

Endpoint Chat Completions

Pošlete zprávy na /v1/chat/completions endpoint pomocí standardního JSON.

Model přijímá user a assistant role. Můžete nakonfigurovat teplotu, top-p a sekvence zastavení pro ovládání stylu výstupu. Odpovědi vrací využití tokenů v posledním bloku, pokud je povoleno streamování.

Copyimport OpenAI from "openai";

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

Nastavit max_tokens pro ovládání délky výstupu. Pokud je toto pole vynecháno, výchozí hodnota je 2 048 tokenů. Model podporuje až 16 000 tokenů na požadavek.

Streamované odpovědi

Povolte streamování nastavením stream: true ve vašem těle požadavku.

Podrobnosti o použití tokenů se objevují pouze v posledním chunku streamu. To umožňuje aktualizace UI v reálném čase při zachování přesných dat pro fakturaci. Chyby během streamování stále hlásí použití pro účtované tokeny.

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)

Zpracovávejte částečné odpovědi elegantně. Stream se normálně ukončí, když model dokončí generování nebo dosáhne limitu kontextu.

Volání funkcí & Režim JSON

Použít response_format: {type: "json_object"} pro přísné výstupy JSON.

Definujte nástroje v tools pole a nastavte tool_choice pro vynucení volání funkcí. Model vrací strukturovaná data vhodná pro programové zpracování. To spolehlivě funguje s našimi uncensored vahami.

Copycurl https://api.apiopenrouter.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the top 5 dependencies for a Go web server"}]
  }'

Kombinujte volání funkcí se streamováním pro interaktivní zážitky. Před předáním výstupu do aplikační logiky ověřte výstup JSON.

Limity a kvóty

Sledujte své využití vzhledem k limitům na klíč, abyste předešli přerušením.

Každý klíč umožňuje 300 požadavků za minutu a 8 souběžných požadavků. Limit velikosti těla požadavku je 8 MB. Pokud tyto limity překročíte, API vrátí stavový kód 429. Chyby autentizace vracejí 401 a nedostatek kreditu vrací 402.

Copycurl https://api.apiopenrouter.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the top 5 dependencies for a Go web server"}]
  }'

Okno kontextu má celkem 100 000 tokenů. Chyby nespotřebovávají kredit. Odmítnutí kvůli drobným porušením obsahu jsou také zdarma.