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

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

Використовуйте наш базовий URL та один API-ключ для підключення. Кінцевий пункт приймає стандартні заголовки. Замініть YOUR_API_KEY за допомогою рядка з вашої панелі керування.

• Базовий URL: https://api.ollamaopenaicompatibleapi.com/v1
• Ідентифікатор моделі: uncensored

Аутентифікація покладається на токен bearer. Передайте його в Authorization header. Це забезпечує сумісність із будь-яким клієнтом, сумісним з SDK OpenAI. Ви можете миттєво згенерувати новий ключ через Google або електронну пошту. Номер телефону не потрібен.

Ендпоінт Chat Completions

Надішліть POST-запит на /v1/chat/completions. Вкажіть масив повідомлень та назву моделі. API повертає текстовий вивід на основі вашого запиту. Це працює з будь-яким постачальником, який використовує стандартні параметри.

Встановіть температуру для креативності або залиште її низькою для точності. Ви також можете визначити послідовності зупинки. Сервер обробляє запит і повертає завершення. Це основна взаємодія для більшості інтеграцій.

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

Copycurl https://api.ollamaopenaicompatibleapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the top 10 Linux kernel security patches from 2023"}]
  }'

Потокові відповіді через SSE

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

Парсуйте потік Server-Sent Events. Останній чанк містить статистику використання. Вона включає кількість токенів як для вхідних, так і для вихідних даних. Ви можете динамічно відстежувати витрати під час генерації.

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

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)

Function Calling та режим JSON

Визначте інструменти в тілі запиту. Модель може виводити структуровані дані. Використовуйте response_format з {"type": "json_object"} для суто JSON. Це гарантує парсний вивід щоразу.

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

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

Copyfrom openai import OpenAI

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

Ліміти частоти та тіла запитів

Ви отримуєте 300 запитів на хвилину на ключ. Паралельність обмежена 8 одночасними запитами. Максимальний розмір тіла запиту становить 8 МБ. Це підходить для більшості текстових додатків.

Контекстне вікно дозволяє 100 000 токенів загалом. Це включає як промпт, так і завершення. Максимальний вивід на запит становить 16 000 токенів. Якщо ви пропустите max_tokens, за замовчуванням встановлюється 2,048.

Обробляйте помилки HTTP 429 коректно. Вони вказують на досягнення ліміту швидкості. Реалізуйте експоненційне сповільнення у коді клієнта. Це запобігає перевантаженню сервера під час сплесків.

Copyimport OpenAI from "openai";

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

Помилки автентифікації та ліміти

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

Статус 429 сигналізує про обмеження швидкості. Ви перевищили ліміт у 300 запитів на хвилину. Зменшіть пропускну здатність або оновіть свій ключ. API повертає зрозумілі повідомлення про помилки.

Кредит не має строку дії. Ви можете поповнити рахунок у будь-який час. Мінімальна сума поповнення — $20. Бонусні кредити застосовуються для більших сум. Це забезпечує стабільну роботу вашого проекту.