Документация по 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. Это возвращает список объектов моделей. Единственный доступный идентификатор модели — "uncensored".

Этот эндпоинт помогает проверить подключение. Он подтверждает, что базовый URL указан верно. Он также показывает имя модели и тип объекта.

Используйте это для отладки проблем с подключением перед отправкой больших объемов данных.

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

Управляйте генерацией с помощью temperature, top_p, и seed. The seed parameter обеспечивает детерминированные результаты. Используйте его для отладки или получения последовательных результатов.

Установить temperature между 0 и 2. Более низкие значения делают ответы более предсказуемыми. Более высокие значения увеличивают случайность. The 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)