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

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

API живе на https://api.ollamaapidoc.com/v1. Ви автентифікуєтесь за допомогою Bearer-токена в Authorization header. Згенеруйте свій ключ миттєво через Google або електронну пошту на панелі керування. Номер телефону не потрібен. Ключ працює зі стандартними SDK OpenAI шляхом встановлення базової URL-адреси.

Ваш перший запит

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

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

Відповідь повертає стандартне форматування OpenAI. Помилки повертають відповідні коди HTTP. Перевірте тіло на наявність error деталі у разі помилки. Потокові відповіді використовують Server-Sent Events.

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

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

Copyfrom openai import OpenAI

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

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

Налаштування SDK Node.js

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

Copyimport OpenAI from "openai";

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

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

Потокова передача та режим JSON

Увімкніть потокову передачу, встановивши stream параметр на true. API надсилає токени через Server-Sent Events. Ви отримуєте часткові відповіді в реальному часі. Це покращує користувацький досвід для довгих виводів. Ви також можете примусово використовувати вивід у форматі JSON, використовуючи response_format. Це корисно для витягування структурованих даних.

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 токенів за запит. Помилки включають 401 для недійсних ключів та 402 для недостатнього балансу. Ліміти швидкості обмежуються 300 запитами на хвилину. Обробляйте їх коректно у вашому додатку. API ніколи не використовує ваші промпти для навчання. Приватність зберігається. Кредити не мають терміну дії.