Документація API & Швидкий старт

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

Почніть із встановлення базового URL на HTTPS://api.uncensoredal.com/v1 та передачі API-ключа в заголовку Authorization. Ви отримуєте один активний ключ на обліковий запис, і генерація нового ключа миттєво анулює попередній. Ця проста настройка працює з будь-яким стандартним клієнтом, сумісним з OpenAI, без складної логіки маршрутизації.

Copycurl https://api.uncensoredal.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Generate the next 50 lines of a python script"}]
  }'

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

Ендпоінт Chat Completions

Надішліть POST-запит до /v1/chat/completions із історією ваших повідомлень у масиві messages. Система обробляє текстовий ввід і повертає згенерований текст без відмов у вмісті для законного дорослого використання. Ви повинні вказати модель як "uncensored" у своєму запиті, щоб забезпечити сумісність.

Copyfrom openai import OpenAI

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

Запити нараховуються на основі фактичного використання токенів, тоді як помилки та відмови залишаються безкоштовними. Ця передоплатна модель означає, що ви платите лише за те, що споживаєте. Ендпоінт підтримує стандартні параметри, такі як temperature та top_p для контролю випадковості виводу.

Потокові відповіді з SSE

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

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 повертає стандартні події потокової передачі, сумісні з OpenAI, що полегшує інтеграцію з існуючими бібліотеками інтерфейсу. Ви можете достроково зупинити потік, якщо користувач змінює свій ввід.

Function Calling та режим JSON

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

Copyimport OpenAI from "openai";

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

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

Конфігурація параметрів моделі

Налаштуйте параметри, такі як temperature, top_p, послідовності stop та seed для контролю поведінки генерації. Вікно контексту підтримує 100,000 токенів як для запиту, так і для відповіді разом. Максимальний обсяг виводу обмежено 16,000 токенів на запит, або 2,048, якщо ви не вказали max_tokens.

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

Ліміти, помилки та контекст

Ліміти швидкості встановлено на рівні 300 запитів на хвилину та 8 одночасних запитів на ключ. Тіла запитів обмежені розміром 8 МБ, тому великі контекстні вікна потрібно керувати обережно. Помилки включають 401 для недійсних ключів, 402 для недостатнього кредитного балансу та 429 для перевищення лімітів швидкості.

Кредит не має строки дії, тому ви можете призупинити використання між сплесками активності без втрати коштів. Якщо ви досягли ліміту одночасних з’єднань, повторіть спробу з експоненційною затримкою. Контекстне вікно на 100,000 токенів дозволяє зберігати велику історію, але слідкуйте за лімітами виводу, щоб уникнути обрізання тексту.