Документація Ollama API: Довідник ендпоінтів

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

Базовий URL для всіх запитів є https://api.ollamaapidocumentation.com/v1. Ви автентифікуєтесь за допомогою bearer-токена, переданого в Authorization header. Ваш ключ генерується на панелі керування і працює миттєво.

• Використовуйте офіційні SDK OpenAI або будь-який сумісний клієнт.
• Вкажіть базовий URL на значення вище.
• Додайте свій API-ключ до заголовка.

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

Ендпоінт Chat Completions: POST /v1/chat/completions

Надсилайте повідомлення до моделі через POST /v1/chat/completions. Ендпоінт приймає тіло у форматі JSON із model field встановлено на "uncensored" та messages масив.

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

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

Перелік моделей: GET /v1/models

Отримайте доступні моделі, використовуючи GET /v1/models. Це повертає список об'єктів моделей. Єдиний доступний ID моделі — "uncensored".

Цей ендпоінт допомагає перевірити підключення. Він підтверджує, що базовий URL правильний. Він також показує назву моделі та тип об'єкта.

Використовуйте це для налагодження проблем із з’єднанням перед надсиланням великих запитів.

Параметри: Temperature, Top P, Seed

Керуйте генерацією з temperature, top_p, а також seed. The seed параметр забезпечує детерміновані результати. Використовуйте його для налагодження або отримання послідовних результатів.

Встановити temperature між 0 та 2. Нижчі значення роблять відповіді більш передбачуваними. Вищі значення збільшують випадковість. Ця top_p параметр фільтрує токени за кумулятивною ймовірністю.

Ці параметри працюють так само, як і API OpenAI. Ви можете поєднувати їх для точного контролю над стилем.

Потокові відповіді та використання токенів

Увімкніть потокову передачу, встановивши stream: true. API повертає Server-Sent Events (SSE). Кожен фрагмент містить частковий текст.

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

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

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

Розмір контекстного вікна становить 100 000 токенів. Це включає як вхідні, так і вихідні токени. Ви можете генерувати до 16 000 токенів за запит. Максимальний обсяг виводу за замовчуванням становить 2 048 токенів.

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

Помилки включають 401 для недійсних ключів та 429 для перевищення лімітів. Помилки, пов’язані з кредитом, повертають код 402. Ці помилки зрозумілі та дають чітке розуміння дій.

cURL

Copycurl https://api.ollamaapidocumentation.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list files in the current directory"}]
  }'

Python

Copyfrom openai import OpenAI

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

Node.js

Copyimport OpenAI from "openai";

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

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

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)