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

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

Кінцевий пункт API знаходиться за адресою https://api.openrouteraiapi.com/v1. Передайте свій API-ключ у Authorization header як Bearer-токен. Цей заголовок — єдина зміна, необхідна для перенаправлення трафіку від вашого поточного постачальника до нашої необмеженої моделі.

Аутентифікація суворий. Якщо ключ відсутній або недійсний, сервер миттєво повертає помилку 401. Ви можете миттєво згенерувати ключ через Google або електронну пошту на панелі керування. Зберігайте ключ у безпеці, оскільки він надає доступ до вашого попередньо оплаченого кредиту.

Ендпоінт Chat Completions

Надсилайте запити POST до /v1/chat/completions з масивом повідомлень. Ідентифікатор моделі uncensored. Ця єдина модель обробляє всі ваші потреби в генерації тексту без складної логіки маршрутизації.

Ось стандартний запит за допомогою cURL для перевірки підключення та формату відповіді.

Copycurl https://api.openrouteraiapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list the top five python libraries for data science"}]
  }'

Відповідь включає згенерований текст у choices[0].message.content поле. Ви можете безпосередньо розпарсити це у свій робочий процес додатка.

Інтеграція SDK Python

Використовуйте офіційний OpenAI Python клієнт для безперешкодного підключення. Встановіть base_url та api_key змінні, щоб вказати на нашу інфраструктуру. Цей підхід мінімізує зміни в коді при переході на іншого постачальника.

Copyfrom openai import OpenAI

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

Клієнт автоматично обробляє серіалізацію та повторні спроби. Ви отримуєте об’єкт завершення, що містить текст та статистику використання токенів. Цей метод ідеально підходить для фонових сервісів та скриптів.

Використання SDK Node.js

Ініціалізуйте клієнт OpenAI Node.js з вашим користувацьким базовим URL. Це дозволяє JavaScript-додаткам взаємодіяти з моделлю без цензури за допомогою знайомих методів. SDK ефективно керує HTTP-запитами.

Copyimport OpenAI from "openai";

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

Виклик chat.completions.create() з вашими повідомленнями. Об'єкт відповіді надає доступ до згенерованого вмісту та даних про використання. Ця інтеграція добре працює для веб-серверів та edge-функцій.

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

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

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)

Кожен чанк містить частковий вміст. Останній чанк містить повну статистику використання токенів. Обробляйте ці події у своєму клієнті, щоб оновлювати інтерфейс користувача поступово.

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

Контекстне вікно підтримує 100,000 токенів для сумісного вводу та виводу. Кожен запит може виводити до 16,000 токенів, або 2,048, якщо max_tokens не встановлено. Ліміти швидкості дозволяють 300 запитів на хвилину на один ключ.

Помилки — це стандартні коди HTTP. 401 вказує на недійсний ключ. 402 означає, що ваш попередньо оплачений кредит вичерпано. 429 сигналізує про перевищення ліміту швидкості. Запити, які завершилися помилкою, не споживають кредит. Помилки безкоштовні.