Dokumentace k API: Průvodce rychlým startem

Základní URL a ověření

API Heretic AI je plně kompatibilní s OpenAI. Interagujete s ním tím, že ukážete svého klienta na naši základní URL: https://api.hereticai.cc/v1. Ověřování spoléhá na jediný API klíč pro účet, vygenerovaný okamžitě při registraci přes Google nebo e-mail. Předejte tento klíč v Authorization hlavička jako Bearer token. Identifikátor modelu je jednoduše uncensored. Tento jediný model zpracovává všechny vaše požadavky bez složitosti směrování. Chyby jako 401 znamenají neplatný klíč, zatímco 402 znamená, že potřebujete více předplacené krypto kreditní částky.

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"}]
  }'

Endpoint Chat Completions

Odesílejte textové požadavky pomocí POST /v1/chat/completions endpoint. API očekává standardní pole zprávy obsahující historii konverzace nebo prompt. Vrací generovaný text v choices pole. Toto je čistý uživatelský API: text vstupuje, text vystupuje. Platíte pouze za spotřebovaný tokeny. Předplacené kredity nevyprší a odmítnutí nebo chyby nestojí tokeny. Tento přístup eliminuje zámky předplatného a nepředvídatelné bezplatné úrovně.

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)

Streamované odpovědi (SSE)

Povolte streamování tokenů v reálném čatu nastavením stream: true ve vaší žádosti. API vrací Server-Sent Events (SSE) pro každý generovaný token. To umožňuje postupné zobrazování výstupu, což je klíčové pro aplikace citlivé na latenci. Statistiky využití tokenů se zobrazí v posledním bloku streamu. Tato funkce bezproblémově funguje se standardními SDK OpenAI, která automaticky zpracovávají SSE. Poskytuje okamžitou zpětnou vazbu bez čekání na kompletní dokončení.

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)

Volání funkcí a nástroje

API podporuje volání funkcí s tools a tool_choice parametry. Definujte schémata svých nástrojů v požadavku a model bude vracet strukturované funkční volání, když je to vhodné. To umožňuje komplexní pracovní postupy, kde LLM rozhoduje, jakou akci provést jako další. Můžete vynutit specifické použití nástrojů nebo nechat model, aby si vybíral volně. Tato funkce je zásadní pro vytváření agentic aplikací, které interagují s externími systémy nebo databázemi.

Režim JSON

Zajistěte deterministický výstup nastavením response_format na {"type": "json_object"}. Model omezí svou odpověď na platný JSON, což je zásadní pro programové parsování. To snižuje potřebu oprav regulárními výrazy v post-processing. Zaručuje, že výstup lze přímo spotřebovat vaším kódem. To je zvláště užitečné pro úlohy extrakce strukturovaných dat nebo generování konfigurace.

Parametry a limity

Ovládejte generování pomocí standardních parametrů jako temperature, top_p, a seed. Kontextové okno má velikost 100 000 tokenů pro prompt plus dokončení. Maximální výstup je 16 000 tokenů na požadavek, nebo 2 048, pokud max_tokens není nastaveno. Omezení rychlosti jsou 300 požadavků za minutu a 8 souběžných požadavků na klíč. Tělo požadavku musí zůstat pod 8 MB. Tato omezení zajišťují stabilní vysokoprovozní využití pro vývojáře.

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);