Документація API: Посібник зі швидкого старту

Базова URL-адреса та аутентифікація

API Heretic AI повністю сумісний з OpenAI. Ви взаємодієте з ним, вказавши клієнту нашу базову URL-адресу: https://api.hereticai.cc/v1. Аутентифікація базується на єдиному API-ключі на акаунт, який генерується миттєво під час реєстрації через Google або електронну пошту. Передайте цей ключ в Authorization header as a Bearer token. The model identifier is simply uncensored. Ця єдина модель обробляє всі ваші запити без складності маршрутизації. Помилки типу 401 вказують на недійсний ключ, тоді як 402 означає, що вам потрібно більше попередньо оплаченого крипто-кредиту.

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

Надсилайте текстові запити, використовуючи POST /v1/chat/completions endpoint. endpoint. API очікує стандартний масив повідомлень, що містить історію вашої розмови або промпт. Він повертає згенерований текст у choices масив. Це чистий утилітарний API: текст в, текст вихід. Ви платите лише за спожиті токени. Попередньо оплачені кредити ніколи не закінчуються, а відмови або помилки не коштують токенів. Цей підхід усуває блокування підписок та непередбачуваний безкоштовний рівень.

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)

Потокові відповіді (SSE)

Увімкніть потокову передачу токенів у реальному часі, встановивши stream: true у вашому запиті. API повертає Server-Sent Events (SSE) для кожного згенерованого токена. Це дозволяє поступово відображати вивід, що є критично важливим для додатків, чутливих до затримок. Статистика використання токенів з'являється у фінальному чанку потоку. Ця функція бездоганно працює зі стандартними SDK OpenAI, які автоматично обробляють SSE. Вона забезпечує миттєвий зворотний зв'язок без очікування повного завершення.

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)

Function Calling та інструменти

API підтримує виклик функцій з tools та tool_choice параметри. Визначте схеми ваших інструментів у запиті, і модель повертатиме структуровані виклики функцій, коли це доречно. Це дозволяє складні робочі процеси, де LLM вирішує, який крок зробити далі. Ви можете примусово вимагати використання конкретних інструментів або дозволити моделі вільно обирати. Ця функція є важливою для створення агентних програм, які взаємодіють із зовнішніми системами або базами даних.

Режим JSON

Забезпечте детермінований вихід, встановивши response_format до {"type": "json_object"}. Модель обмежуватиме свою відповідь валідним JSON, що є життєво важливим для програмного парсингу. Це зменшує потребу в постобробці для виправлення регулярних виразів. Вона гарантує, що вивід можна безпосередньо споживати вашим кодом. Це особливо корисно для витягування структурованих даних або генерації конфігурацій.

Parameters and Limits

Керуйте генерацією за допомогою стандартних параметрів, таких як temperature, top_p, а також seed. Контекстне вікно становить 100,000 токенів для запиту плюс завершення. Максимальний вихід — 16,000 токенів за запит, або 2,048, якщо max_tokens не встановлено. Ліміти швидкості становлять 300 запитів на хвилину та 8 одночасних запитів на ключ. Розмір тіла запиту має бути меншим за 8 МБ. Ці ліміти забезпечують стабільну роботу при великому навантаженні для розробників.

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