Документация API & Быстрый старт

Базовый URL и аутентификация

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

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

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

Эндпоинт 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. Бонусные кредиты начисляются за крупные суммы. Это обеспечивает стабильную работу вашего проекта.