API-dokumentation: Quickstart Guide

Bas URL och autentisering

Heretic AI API är helt OpenAI-kompatibelt. Du interagerar med det genom att peka din klient mot vår bas-URL: https://api.hereticai.cc/v1. Autentisering bygger på en enda API-nyckel per konto, som genereras omedelbart vid registrering via Google eller e-post. Skicka denna nyckel i Authorization header som ett Bearer-token. Modellidentifieraren är helt enkelt uncensored. Denna enda modell hanterar alla dina begäranden utan routningskomplexitet. Fel som 401 indikerar en ogiltig nyckel, medan 402 betyder att du behöver mer förbetalt kryptosaldo.

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

Slutpunkt för chattkomplettering

Skicka textförfrågningar med hjälp av POST /v1/chat/completions endpoint. API:et förväntar sig en standard messages-array som innehåller din konversationshistorik eller prompt. Den returnerar genererad text i choices array. Detta är ett rent verktygs-API: text in, text ut. Du betalar endast för förbrukade tokens. Förbetalt kredit utgår aldrig, och avvisningar eller fel kostar inte tokens. Detta tillvägagångssätt eliminerar prenumerationsspärrar och oförutsägbara gratisnivåer.

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)

Strömningsresponser (SSE)

Aktivera realtidsströmning av tokens genom att ställa in stream: true i ditt begäran. API:t returnerar Server-Sent Events (SSE) för varje genererad token. Detta gör att du kan visa utdata progressivt, vilket är avgörande för latenskänsliga applikationer. Tokenanvändningsstatistik visas i den sista chunken av strömmen. Denna funktion fungerar sömlöst med standard OpenAI SDK:er som hanterar SSE automatiskt. Den ger omedelbar feedback utan att vänta på hela kompletteringen.

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)

Funktionsanrop och verktyg

API:en stöder function calling med tools och tool_choice parametrar. Definiera dina verktygsscheman i begäran, så returnerar modellen strukturerade funktionsanrop vid lämpliga tillfällen. Detta möjliggör komplexa arbetsflöden där LLM:n bestämmer vilken åtgärd som ska vidtas härnäst. Du kan tvinga fram specifik verktygsanvändning eller låta modellen välja fritt. Denna funktion är avgörande för att bygga agentic-applikationer som interagerar med externa system eller databaser.

JSON-läge

Säkerställ deterministiska svar genom att ställa in response_format för {"type": "json_object"}. Modellen kommer att begränsa sitt svar till giltig JSON, vilket är viktigt för programmatisk parsning. Detta minskar behovet av efterbehandling med regex-korrigeringar. Den garanterar att utdata kan konsumeras direkt av din kod. Detta är särskilt användbart för strukturerad dataextraktion eller konfigurationsgenerering.

Parameters and Limits

Styr genereringen med standardparametrar som temperature, top_p, och seed. Kontextfönstret är 100,000 token för prompt plus komplettering. Max utmatning är 16,000 token per begäran, eller 2,048 om max_tokens är inställt. Hastighetsbegränsningarna är 300 begäranden per minut och 8 samtidiga begäranden per nyckel. Begärandekroppen måste hålla sig under 8 MB. Dessa gränser säkerställer stabil högvolymningsanvändning för utvecklare.

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