Документація API

Швидкий старт: Перший запит з Python або JS

Надішліть свій перший промпт і одразу отримайте сирний текстовий вивід. API приймає стандартні запити chat-completion, тому ви можете підставити нашу базову URL-адресу та ключ, щоб почати генерувати контент без цензури, не переписуючи логіку. Використовуйте наведену нижче команду cURL для перевірки підключення та доступності моделі перед інтеграцією у свій код.

Цей початковий запит підтверджує, що ендпоінт доступний і що ваш токен автентифікації є дійсним. Після цього ви можете продовжити розробку логіки вашого застосунку, використовуючи надані обгортки SDK.

Copycurl https://api.chatunrestricted.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the three main endpoints for user authentication"}]
  }'

Автентифікація & базовий URL

Автентифікація шляхом передачі вашого API-ключа в HTTP-заголовку. Усі запити мають спрямовуватися на базовий URL https://api.chatunrestricted.com/v1 для забезпечення сумісності з SDK OpenAI. Ви можете миттєво згенерувати свій ключ через панель керування, використовуючи облікові дані Google або електронної пошти, без необхідності вказувати номер телефону.

Ключ API ідентифікує ваш обліковий запис і відстежує використання токенів проти вашого попередньо оплаченого балансу. Зберігайте цей ключ у безпеці, оскільки він надає прямий доступ до ваших коштів. На один обліковий запис дозволено лише один активний ключ; генерація нового ключа автоматично робить попередній ключ недійсним.

POST /v1/chat/completions

Генеруйте текст, надсилаючи запит POST до кінцевої точки chat completions. Ідентифікатор моделі — uncensored, що запускає модель з відкритими вагами, налаштовану для відповідей без відмов за змістом для законного дорослого використання. Ви можете контролювати довжину виводу, випадковість та умови зупинки за допомогою стандартних параметрів.

Цей ендпоінт підтримує потокове передавання, виклик функцій та відповіді в режимі JSON. Він не підтримує вбудовування (embeddings), зображення або донавчання. Використовуйте Python SDK для асинхронної обробки запитів, щоб підвищити продуктивність у вебдодатках.

Copyfrom openai import OpenAI

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

GET /v1/models

Отримайте список доступних моделей, щоб підтвердити структуру API. Відповідь містить uncensored model ID, який ви повинні вказати у запитах на генерацію. Цей ендпоінт допомагає переконатися, що служба працює онлайн і що ID моделі не змінився.

Використовуйте цю кінцеву точку для налагодження проблем підключення перед надсиланням дорогих запитів на генерацію. Вона повертає стандартні метадані моделі, сумісні з OpenAI, включаючи ID моделі та тип об'єкта.

Copyimport OpenAI from "openai";

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

Параметри: Temperature, Top P, Seed

Керуйте випадковістю та детермінованістю ваших виводів за допомогою стандартних параметрів вибірки. Встановіть temperature між 0 та 2 для налаштування креативності та використовуйте top_p щоб обмежити nucleus-вибір. Цей seed параметр дозволяє відтворювати конкретні результати для налагодження або сценаріїв ролевих ігор.

Ці параметри безпосередньо впливають на те, як модель генерує текст. Вищі значення температури дають більш різноманітні відповіді, тоді як нижчі роблять вивід більш зосередженим та передбачуваним. Використовуйте stop послідовності для зупинки генерації за певними маркерами.

Потокова передача, інструменти та режим JSON

Потокова передача відповідей у реальному часі за допомогою Server-Sent Events (SSE) для зниження затримки. Увімкніть режим JSON, встановивши response_format до json_object для витягування структурованих даних. Підтримується виклик інструментів для виконання функцій, що дозволяє моделі викликати зовнішні API.

Потокова передача (Streaming) є критично важливою для створення чат-інтерфейсів, які відображають токени по мірі їх генерації. Останній фрагмент потоку містить загальне використання токенів для запиту, що дозволяє точно відстежувати билінг. Використовуйте наведений нижче приклад для реалізації потокової передачі у вашому додатку.

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)

Ліміти частоти та розрахунок

Відстежуйте ліміти швидкості, щоб уникнути перерв у роботі під час використання великого обсягу даних. API встановлює ліміт 300 запитів на хвилину та ліміт паралельності 8 одночасних запитів на ключ. Максимальний розмір тіла запиту становить 8 МБ.

Оплата є передоплаченою та базується на реальному використанні токенів. Помилки та відмови не витрачають кредит. Якщо ви зіткнулися з помилкою 401, ваш API-ключ недійсний. Помилка 402 вказує на недостатній кредит, тоді як помилка 429 означає, що ви перевищили ліміт частоти запитів. Контекстне вікно підтримує 100,000 токенів для промпту та завершення разом.