Быстрый старт для пользователей Ollama

Предварительные требования

Для работы с API вам нужен активный аккаунт с валидным API-ключом. Зарегистрируйтесь на странице Получить API-ключ через Google или email с паролем. Номер телефона не требуется. Также вам нужно установить SDK для поддерживаемого языка. Это руководство охватывает Python и Node.js — самые популярные клиенты для эндпоинтов, совместимых с OpenAI. API обслуживает одну модель без цензуры с идентификатором uncensored. Она принимает текст и возвращает текст. Эмбеддингов, изображений или аудио нет. Все запросы отправляются на https://api.ollamaapi.cc/v1.

Установка SDK

Установите официальный SDK для выбранного языка. Для Python используйте pip. Для Node.js — npm. Эти библиотеки автоматически обрабатывают HTTP-протокол, сериализацию JSON и потоковую передачу. Вам не нужно писать сырые HTTP-запросы, если вы не предпочитаете такой уровень контроля. SDK хорошо документированы и широко используются в продакшене. Убедитесь, что ваша среда соответствует требованиям SDK. Рекомендуется Python 3.8+ и Node.js 18+. Обновляйте зависимости, чтобы избежать проблем с новыми параметрами модели.

Настройка клиента

Установите базовый URL для нашего эндпоинта. Это единственное изменение в конфигурации, необходимое для перехода с OpenAI на наш сервис без цензуры. Передайте ваш API-ключ в заголовке авторизации. SDK сделает всё остальное. Не меняйте имя модели на gpt-4 или подобное; используйте uncensored. API строго следует протоколу OpenAI chat-completions. Любой клиент, работающий с OpenAI, будет работать здесь с этими двумя изменениями. Это упрощает миграцию или A/B-тестирование. Вы можете запустить оба API параллельно для сравнения результатов.

Отправка первого запроса

Отправьте POST-запрос к /v1/chat/completions. Укажите идентификатор модели, системный промпт и сообщение пользователя. API возвращает текстовый ответ. Если у вас есть кредит, запрос выполняется успешно. При отсутствии кредита вы получите ошибку 402. При недействительном ключе — ошибку 401. Эти ошибки стандартны и легко обрабатываются в коде. Модель не отказывает в законном контенте для взрослых, что делает её полезной для творческого письма, исследований в области безопасности или общения без цензуры. Проверьте баланс на панели управления, если не уверены в остатке кредитов.

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

Включите потоковую передачу, установив stream: true. API возвращает токены по мере их генерации. Это снижает воспринимаемую задержку для пользователей. Последний фрагмент содержит общее количество использованных токенов для биллинга. Потоковая передача поддерживается всеми официальными SDK. Это необходимо для чат-интерфейсов, где нужно показывать текст по мере его появления. Сервер отправляет Server-Sent Events (SSE). Ваша клиентская библиотека обрабатывает парсинг. Вам не нужно управлять потоком событий вручную, если вы не создаете собственный клиент.

Лимиты, ошибки и контекст

Контекстное окно составляет 100 000 токенов в сумме, с максимальным выводом 32 000 токенов. Запросы ограничены 300 в минуту и 8 параллельными запросами на ключ. Тело запроса должно быть меньше 8 МБ. Ошибки включают 401 для недействительных ключей, 402 для недостаточного кредита и 429 для лимитов запросов. Это стандартные коды HTTP. Обрабатывайте их корректно в вашем приложении. Модель блокирует сексуальный контент с участием несовершеннолетних. Весь остальной контент разрешен. Кредит никогда не сгорает, поэтому вы можете приостановить использование без потери средств. Обратитесь на страницу поддержки для вопросов по возврату средств.

cURL

Copycurl https://api.ollamaapi.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
  }'

Python

Copyfrom openai import OpenAI

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