Документация API, совместимого с OpenAI

Предварительные требования: SDK и базовый URL

Начните с установки предпочитаемой библиотеки и указания ее на наш эндпоинт. The base_url является https://api.apicompatible.com/v1. Документация по совместимому с OpenAI API подтверждает, что стандартные библиотеки работают сразу. Вам не нужен маршрутизатор или сложная настройка шлюза. Измените URL и ключ, затем запустите существующий код.

Аутентификация: Заголовок и формат ключа

Передайте свой ключ в Authorization header. Используйте формат Bearer your_api_key. Наш API использует стандартную структуру ключей API, совместимую с OpenAI. Ключи генерируются мгновенно через вход в Google или по электронной почте. Храните ключ в безопасности, так как он предоставляет доступ к вашему предоплаченному балансу.

Эндпоинт Chat Completions

Отправляйте запросы в /v1/chat/completions. Укажите модель как uncensored. API возвращает текстовые ответы напрямую. Используйте следующую команду curl для проверки подключения:

Copycurl https://api.apicompatible.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List available models"}]
  }'

Этот совместимый с SDK OpenAI подход обеспечивает генерацию текста без ограничений. Модель обрабатывает сложные запросы без ненужных отказов для законного контента.

Потоковые ответы с SSE

Включите потоковую передачу, установив stream: true. Ответы поступают через Server-Sent Events (SSE). Детали использования токенов отображаются в последнем чанке. Эта OpenAI-совместимая документация API поддерживает стандартные протоколы потоковой передачи. Используйте это для создания интерактивных пользовательских интерфейсов:

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.apicompatible.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 и Tools

Управляйте генерацией с помощью стандартных параметров. Установите temperature для случайности или top_p для выборки по ядру. Включите tools для вызова функций. Режим JSON доступен через response_format. The uncensored модель эффективно учитывает эти ограничения:

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.apicompatible.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-структуры для программных сценариев использования.

Лимиты: Лимиты скорости и размер тела

Каждый ключ позволяет выполнять 300 запросов в минуту. Одновременные запросы ограничены 8 на ключ. Максимальный размер тела запроса составляет 8 МБ. Контекстное окно поддерживает 100,000 токенов суммарно. Обрабатывайте ошибки 401, проверяя ключ. Решайте ошибки 402, пополняя кредит. Управляйте ошибками 429, внедряя логику задержки.

Потоковая передача

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)