Документация API
Начните работу с нашим uncensored LLM API за считанные минуты, используя стандартные SDK OpenAI. Это краткое руководство охватывает аутентификацию, форматы запросов и потоковую передачу для немедленной интеграции.
Аутентификация & базовый URL
Используйте свой API-ключ с базовым URL https://api.paidapi.cc/v1. Передайте ключ в Authorization заголовок как Bearer-токен. Эта настройка работает с любой библиотекой клиентов, совместимой с OpenAI, без дополнительных шагов конфигурации.
curl https://api.paidapi.cc/v1/chat/completions \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [{"role": "user", "content": "Set up a cron job to run every hour"}]
}'Храните ваш ключ в безопасности. Если вы его потеряете, сгенерируйте новый на панели управления. Старый ключ немедленно перестает работать.
Первый запрос
Отправьте POST-запрос на /v1/chat/completions с моделью "uncensored". Включите массив сообщений в тело запроса. API возвращает текстовые завершения на основе контекста вашего запроса.
from openai import OpenAI
client = OpenAI(base_url="https://api.paidapi.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)Этот простой вызов подтверждает работоспособность вашей интеграции. Проверьте объект ответа на использование токенов и контент.
Потоковые ответы
Включите потоковую передачу, установив stream: true. API отправляет частичные чанки по мере их генерации. Это снижает воспринимаемую задержку для длинных выводов.
import OpenAI from "openai";
const client = new OpenAI({ baseURL: "https://api.paidapi.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);Обрабатывайте каждый фрагмент индивидуально. Агрегируйте их, чтобы построить итоговый ответ. Последний фрагмент содержит общее количество использованных токенов для запроса.
Вызов функций & инструменты
Определите инструменты в теле запроса. Модель возвращает вызовы инструментов, когда это уместно. Разберите имя функции и аргументы из ответа.
Установить tool_choice для управления тем, когда модель использует инструменты. Используйте "auto" для автоматического выбора или укажите имя инструмента. Эта функция надежно работает с нашей uncensored моделью для сложных задач.
Конфигурация режима JSON
Установить response_format для {"type": "json_object"}. Модель структурирует вывод в виде валидного JSON. Это упрощает парсинг для программных рабочих процессов.
Убедитесь, что ваш промпт четко указывает схему JSON. Модель соблюдает структуру, которую вы определяете. Используйте этот режим для извлечения данных или задач структурированной генерации.
Лимиты и ошибки
Вы получаете 300 запросов в минуту и 8 одновременных запросов на ключ. Превышение этих лимитов возвращает ошибку 429. Тела запросов должны быть менее 8 МБ. Контекстное окно составляет 100 000 токенов в целом.
Обработка ошибок 401 путем проверки ключа. Ошибки 402 означают, что вам нужно больше кредита. Ошибки не потребляют токены. Поддерживайте предоплаченный кредит пополненным, чтобы избежать прерываний.
Потоковая передача
stream = 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)Часто задаваемые вопросы
Каков базовый URL для API?
Базовый URL: HTTPS://api.paidapi.cc/v1. Используйте этот эндпоинт для всех запросов. Совместимо со стандартными SDK OpenAI.
Как обрабатывать потоковые ответы?
Установите параметр stream в true в запросе. API отправляет чанки данных по мере их генерации. Это позволяет отображать вывод в реальном времени.
Что произойдет, если я превышу лимит частоты запросов?
API возвращает код состояния 429. Вам необходимо дождаться сброса лимита. Лимит составляет 300 запросов в минуту на ключ.
Ваш API-ключ ожидает
Зарегистрируйтесь, получите ключ, обновите базовый URL. Вот и всё.