Dokumentasi API: Panduan Permulaan Pantas

URL Asas dan Pengesahan

API Heretic AI sepenuhnya serasi dengan OpenAI. Anda berinteraksi dengannya dengan mengarahkan klien anda ke URL asas kami: https://api.hereticai.cc/v1. Pengesahan bergantung pada satu kunci API per akaun, yang dijana serta-merta semasa pendaftaran melalui Google atau e-mel. Hantar kunci ini dalam Authorization pencap sebagai token Bearer. Pengenal model hanyalah uncensored. Model tunggal ini mengendalikan semua permintaan anda tanpa kompleksiti pengaliran. Ralat seperti 401 menunjukkan kunci tidak sah, manakala 402 bermakna anda memerlukan lebih kredit kripto pra-bayar.

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

Hujung Sambungan Penyelesaian Sembang

Hantar permintaan teks menggunakan POST /v1/chat/completions endpoint. API ini mengharapkan array mesej standard yang mengandungi sejarah perbualan atau prompt anda. Ia mengembalikan teks yang dijana dalam choices array. Ini adalah API utiliti tulen: teks masuk, teks keluar. Anda hanya membayar untuk token yang digunakan. Kredit pra-dibayar tidak luput, dan penolakan atau ralat tidak menelan kos token. Pendekatan ini menghapuskan kunci langganan dan tahap percuma yang tidak dapat diramal.

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)

Respons Streaming (SSE)

Aktifkan aliran token masa nyata dengan menetapkan stream: true dalam permintaan anda. API mengembalikan Acara Dihantar Pelayan (SSE) untuk setiap token yang dijana. Ini membolehkan anda memaparkan output secara progresif, yang penting untuk aplikasi sensitif latensi. Statistik penggunaan token muncul dalam potongan akhir aliran. Ciri ini berfungsi dengan lancar dengan SDK OpenAI standard yang mengendalikan SSE secara automatik. Ia memberikan maklum balas segera tanpa menunggu penyelesaian penuh.

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)

Panggilan Fungsi dan Alat

API ini menyokong panggilan fungsi dengan tools dan tool_choice parameter. Takrifkan skema alat anda dalam permintaan, dan model akan memulangkan panggilan fungsi berstruktur apabila sesuai. Ini membolehkan aliran kerja kompleks di mana LLM memutuskan tindakan seterusnya. Anda boleh memaksa penggunaan alat tertentu atau membiarkan model memilih secara bebas. Keupayaan ini penting untuk membina aplikasi agentic yang berinteraksi dengan sistem luaran atau pangkalan data.

Mod JSON

Pastikan output deterministik dengan menetapkan response_format ke {"type": "json_object"}. Model ini akan mengekang responsnya kepada JSON yang sah, yang sangat penting untuk penguraian berprogram. Ini mengurangkan keperluan untuk pembetulan regex pasca-pemprosesan. Ia menjamin bahawa output boleh dimakan terus oleh kod anda. Ini sangat berguna untuk pengekstrakan data berstruktur atau tugas penjanaan konfigurasi.

Parameter dan Had

Kawal penjanaan dengan parameter standard seperti temperature, top_p, dan seed. Tetingkap konteks ialah 100,000 token untuk prompt ditambah penyelesaian. Output maksimum ialah 16,000 token setiap permintaan, atau 2,048 jika max_tokens tidak ditetapkan. Had kadar ialah 300 permintaan setiap minit dan 8 permintaan serentak per kunci. Badan permintaan mesti berada di bawah 8 MB. Had ini memastikan penggunaan bervolume tinggi yang stabil untuk pembangun.

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