Быстрый старт для пользователей OpenRouter

Установка и настройка

Наш API полностью совместим со стандартными SDK OpenAI. Чтобы перейти с OpenRouter, вам нужно обновить только два параметра конфигурации: base_url и api_key. Укажите клиенту адрес https://api.openrouterapi.cc/v1 и используйте ключ, сгенерированный в нашем личном кабинете. Дополнительные заголовки или сложная логика маршрутизации не требуются. Идентификатор модели для запроса — uncensored.

Убедитесь, что версия вашего SDK поддерживает параметр base_url. Если вы используете клиент HTTP напрямую, просто обновите целевой URL. Эта настройка гарантирует, что ваш существующий код клиента будет работать без изменений, если вы отправляете только запросы на завершение текста.

Аутентификация

Аутентификация осуществляется через стандартный заголовок Authorization. Передайте ваш API-ключ в качестве токена Bearer. Если ключ недействителен или истек, API возвращает ошибку 401. В отличие от некоторых провайдеров, мы не берем плату за неудачные запросы; ошибки и отказы бесплатны, поэтому вы можете протестировать аутентификацию, не расходуя баланс.

Каждая учетная запись поддерживает один активный ключ одновременно. Генерация нового ключа немедленно делает предыдущий недействительным. Храните ключ в безопасности и меняйте его, если подозреваете его компрометацию. Ключ отображается сразу после регистрации, поэтому скопируйте его, прежде чем покинуть страницу.

Базовое завершение чата

Основная функциональность — эндпоинт POST /v1/chat/completions. Отправьте ваш промпт в виде списка сообщений и получите текстовый ответ. Модель настроена на ответы без отказов по содержанию для законного использования взрослыми, что делает ее подходящей для творческих, спорных тем или исследований в области безопасности.

Установите поле model в значение uncensored. Вы можете управлять поведением с помощью параметров, таких как temperature, top_p и stop. API поддерживает JSON-режим через response_format и вызов функций через tools. Все запросы обрабатываются асинхронно, и вы получаете полное завершение, когда модель закончит работу.

Потоковые ответы

Включите потоковую передачу, установив stream: true в запросе. API возвращает события, отправляемые сервером (SSE), с частичными ответами. Вы получаете фрагменты текста по мере их генерации, что позволяет отображать их в реальном времени в вашем приложении.

Информация об использовании токенов предоставляется в последнем фрагменте потока. Это позволяет точно отслеживать расходы, не разбирая каждый отдельный токен. Потоковая передача идеальна для интерфейсов чата, где важна задержка. Убедитесь, что ваш клиент правильно обрабатывает SSE и закрывает соединение, когда поток заканчивается.

Вызов функций

API поддерживает вызов функций через параметр tools. Определите ваши функции в массиве tools и установите tool_choice в значение auto или конкретное имя функции. Модель вернет структурированные аргументы в формате JSON, если будет вызвана функция.

Эта функция полезна для интеграции LLM с внешними API или базами данных. Убедитесь, что определения ваших функций точны, так как модель полагается на них для генерации корректных аргументов. API не выполняет функции; вы должны обработать логику выполнения в коде вашего приложения.

JSON-режим

Для структурированных выходов используйте response_format: {"type": "json_object"}. Это заставляет модель возвращать действительный JSON, что необходимо для обработки данных в последующих приложениях. JSON-режим часто более надежен, чем вызов функций, для простых задач извлечения данных.

Убедитесь, что ваши промпты четко указывают модели вернуть JSON. Ответы с недействительным JSON могут возникнуть, если промпт неоднозначен. JSON-режим поддерживается как в стандартном, так и в потоковом режимах. Используйте его, когда вам нужны предсказуемые, машиночитаемые выходные данные.

Лимиты, ошибки и контекст

Контекстное окно составляет 100 000 токенов для промпта и завершения вместе. Максимальный вывод — 32 000 токенов на запрос (2 048, если max_tokens не установлен). Лимиты запросов — 300 запросов в минуту и 8 одновременных запросов на ключ. Тела запросов ограничены 8 МБ.

Ошибки возвращают стандартные коды HTTP: 401 для недействительных ключей, 402 для недостатка средств и 429 для лимитов запросов. Баланс предоплаченный, поэтому ошибка 402 означает, что вам нужно пополнить его. Ошибки и отказы бесплатны, поэтому вы можете повторить попытку без затрат. Жёсткое ограничение контента блокирует сексуальный контент с участием несовершеннолетних.

cURL

Copycurl https://api.openrouterapi.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
  }'

Python

Copyfrom openai import OpenAI

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

Node.js

Copyimport OpenAI from "openai";

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

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

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)