Dokumentace pro klíč API kompatibilní s OpenAI

Ověření a základní URL

Použijte svůj vygenerovaný klíč s poskytnutou základní URL pro okamžité připojení. Koncový bod je https://api.openaicompatibleapikey.com/v1 a funguje s jakýmkoli klientem kompatibilním s OpenAI. Na účet dostanete jeden aktivní klíč; vygenerování nového nahradí starý. Autentizace je řešena přes Authorization hlavička s Bearer schéma. Pro registraci není vyžadováno telefonní číslo a můžete začít s bezplatným testovacím kreditem $0.50.

První požadavek pomocí curl

Pošlete jednoduchou zprávu pro ověření připojení a modelu bez omezení. Požadavek používá standardní POST /v1/chat/completions endpoint s ID modelu nastaveným na uncensored. To potvrzuje, že váš klíč API je platný a koncový bod je dosažitelný, než ho integrujete do své aplikace. Odpověď obsahuje využití tokenů a vygenerovaný text.

Copycurl https://api.openaicompatibleapikey.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Calculate the total price including tax"}]
  }'

Integrace Python SDK

Integrujte API do svých projektů Python přepsáním výchozí základní URL. To vám umožní použít oficiální openai knihovnu s naším LLM bez omezení bez změny logiky kódu. Předáte svůj API klíč a specifickou základní URL do inicializace klienta. ID modelu zůstává uncensored pro všechny požadavky.

Copyfrom openai import OpenAI

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

Integrace SDK pro Node

Připojte své aplikace Node.js nastavením baseURL a apiKey vlastnosti. To zajišťuje kompatibilitu s existujícím kódem klienta kompatibilním s OpenAI. Můžete pokračovat v používání standardních parametrů jako messages a model. Klient bude směrovat požadavky na naše hostované servery pro generování bez omezení.

Copyimport OpenAI from "openai";

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

Streamování odpovědí a využití tokenů

Povolte streamování nastavením stream: true v parametrech požadavku. API vrací Server-Sent Events (SSE) pro doručování tokenů v reálném čase. Údaje o spotřebě tokenů jsou zahrnuty v poslední části streamu. To vám umožňuje sledovat náklady a využití kontextu během generování textu. Model podporuje kontextové okno o velikosti 100,000 tokenů.

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)

Omezení rychlosti, chyby a limity

Sledujte svou kvótu, abyste předešli výpadkům služby. Limit je 300 požadavků za minutu na klíč a 8 souběžných požadavků. Chyba 401 označuje neplatný klíč, zatímco 402 signalizuje nedostatek kreditu. Chyby a odmítnutí jsou zdarma. Kontextové okno má 100,000 tokenů, s maximálním výstupem 16,000 tokenů na požadavek. Kredit nevyprší.