Dokumentace API

Základní URL a ověření

Koncový bod API se nachází na https://api.openrouteraiapi.com/v1. Předáte svůj API klíč v Authorization hlavička jako bearer token. Toto je jediná změna, kterou potřebujete provést, abyste přesměrovali provoz z vašeho aktuálního poskytovatele na náš model bez omezení.

Ověření je přísné. Pokud chybí klíč nebo je neplatný, server okamžitě vrátí chybu 401. Klíč můžete vygenerovat okamžitě přes Google nebo e-mail v ovládacím panelu. Uchovávejte klíč v bezpečí, protože poskytuje přístup k vašemu předplacenému kreditu.

Endpoint Chat Completions

Odesílejte požadavky POST na /v1/chat/completions s polem messages. Identifikátor modelu je uncensored. Tento jediný model zpracovává veškeré vaše potřeby generování textu bez složité logiky směrování.

Zde je standardní požadavek pomocí cURL pro ověření připojení a formátu odpovědi.

Copycurl https://api.openrouteraiapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list the top five python libraries for data science"}]
  }'

Odpověď zahrnuje vygenerovaný text v choices[0].message.content pole. Toto můžete přímo parsovat do pracovního postupu vaší aplikace.

Integrace Python SDK

Použijte oficiálního klienta Python OpenAI pro bezproblémové připojení. Nastavte base_url a api_key proměnné tak, aby směřovaly na naši infrastrukturu. Tento přístup minimalizuje změny kódu při přechodu mezi poskytovateli.

Copyfrom openai import OpenAI

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

Klient automaticky zpracovává serializaci a opakované pokusy. Obdržíte objekt dokončení obsahující text a statistiky využití tokenů. Tato metoda je ideální pro backendové služby a skripty.

Využití SDK Node.js

Inicializujte klienta Node.js OpenAI se svou vlastní základní URL. To umožňuje aplikacím JavaScript interagovat s modelem bez omezení pomocí známých metod. SDK efektivně spravuje HTTP požadavky.

Copyimport OpenAI from "openai";

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

Volání chat.completions.create() vašimi zprávami. Objekt odpovědi poskytuje přístup k vygenerovanému obsahu a údajům o využití. Tato integrace dobře funguje pro webové servery a okrajové funkce.

Streamované odpovědi

Povolte streamování nastavením stream: true ve vaší žádosti. Server vrací Server-Sent Events (SSE) pro doručování tokenů v reálném čase. Tato funkce snižuje vnímanou latenci pro koncové uživatele.

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)

Každý chunk obsahuje částečný obsah. Poslední chunk obsahuje úplné statistiky využití tokenů. Tyto události zpracujte ve svém klientovi, abyste aktualizovali uživatelské rozhraní postupně.

Limity, chyby a kontextové okno

Okno kontextu podporuje 100 000 tokenů pro kombinovaný vstup a výstup. Každý požadavek může vygenerovat až 16 000 tokenů, nebo 2 048, pokud max_tokens není nastaveno. Omezení rychlosti umožňují 300 požadavků za minutu na klíč.

Chyby jsou standardní kódy HTTP. 401 označuje neplatný klíč. 402 znamená, že je vyčerpán váš předplacený kredit. 429 signalizuje překročení limitu. Selhané požadavky nespotřebují kredit. Chyby jsou zdarma.