API dokumentáció: Gyors kezdési útmutató

Base URL és Hitelesítés

A Heretic AI API teljesen OpenAI-kompatibilis. Úgy kommunikálsz vele, hogy a kliensedet az alap URL-re irányítod: https://api.hereticai.cc/v1. A hitelesítés egy fiúkonkénti API kulcsra épül, amely azonnal generálódik regisztrációkor Google vagy e-mail segítségével. Add át ezt a kulcsot a Authorization fejléc mint Bearer token. A modell azonosítója egyszerűen uncensored. Ez az egyetlen modell kezeli az összes kérését útválasztási komplexitás nélkül. A 401-es hibák érvénytelen kulcsot jeleznek, míg a 402-es azt jelenti, hogy több előlegesen fizetett kriptokreditre van szüksége.

Copycurl https://api.hereticai.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "generate twenty test cases"}]
  }'

Chat Completions végpont

Szövegkérések küldése a POST /v1/chat/completions endpoint. Az API egy standard üzenetek tömböt vár, amely tartalmazza a beszélgetés előzményeit vagy a promptot. Generált szöget ad vissza a choices tömb. Ez egy tisztán hasznossági API: szöveg be, szöveg ki. Csak a felhasznált tokenekért fizet. Az előre fizetett hitel sosem jár le, a visszautasítások vagy hibák nem fogyasztanak tokeneket. Ez a megközelítés kiküszöböli a előfizetési zárolásokat és a kiszámíthatatlan ingyenes szinteket.

Copyfrom openai import OpenAI

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

Streamelési válaszok (SSE)

Engedélyezze a valós idejű token-streamelést úgy, hogy stream: true a kérésben. Az API minden generált tokenhez Szerver által küldött eseményeket (SSE) ad vissza. Ez lehetővé teszi a kimenet fokozatos megjelenítését, ami kritikus a késleltetés-érzékeny alkalmazások számára. A token-felhasználási statisztikák az utolsó darabban jelennek meg a streamben. Ez a funkció zökkenőmentesen működik a szabványos OpenAI SDK-kkal, amelyek automatikusan kezelik az SSE-t. Azonnali visszajelzést biztosít anélkül, hogy várnia kellene a teljes befejezésre.

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)

Függvényhívás és eszközök

Az API a tools és tool_choice paraméterek. Határozza meg eszközei sémáit a kérelemben, és a modell strukturált függvényhívásokat ad vissza, amikor megfelelő. Ez lehetővé teszi a komplex munkafolyamatokat, ahol az LLM dönti el, hogy milyen műveletet hajtson végre legközelebb. Kikényszerítheti az eszközhasználatot, vagy hagyhatja a modellt szabadon választani. Ez a képesség alapvető az olyan ügynökalkalmazások építéséhez, amelyek külső rendszerekkel vagy adatbázisokkal kommunikálnak.

JSON mód

Biztosítsa a determinisztikus kimenetet a beállítással response_format a {"type": "json_object"}. A modell a válaszát érvényes JSON-ra korlátozza, ami elengedhetetlen a programozott elemzéshez. Ez csökkenti az utólagos regex javítások szükségességét. Garantálja, hogy a kimenet közvetlenül felhasználható legyen a kódja által. Ez különösen hasznos strukturált adatkinyerés vagy konfigurációgenerálás feladatokhoz.

Paraméterek és korlátok

Generálás szabályozása standard paraméterekkel, mint temperature, top_p, és seed. A kontextusablak 100 000 token a prompt és a kiegészítés számára. A maximális kimenet 16 000 token kérésenként, vagy 2 048, ha max_tokens nincs beállítva. A sebességkorlátozás percenként 300 kérés és kulcsonként 8 párhuzamos kérés. A kérés törzse nem haladhatja meg a 8 MB-ot. Ezek a határok biztosítják a stabil, nagy terhelésű használatot a fejlesztők számára.

Node.js

Copyimport OpenAI from "openai";

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