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

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

API находится по адресу https://api.ollamaapidoc.com/v1. Вы аутентифицируетесь с помощью токена Bearer в Authorization Заголовок. Сгенерируйте ключ мгновенно через Google или email в панели управления. Номер телефона не требуется. Ключ работает со стандартными 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.

Интеграция Python SDK

Установите официальную библиотеку OpenAI. Настройте клиент с вашим базовым URL и ключом API. Вызовите конечную точку chat completions. Код остается идентичным стандартному использованию OpenAI. Это обеспечивает легкую миграцию для существующих проектов. Вы можете настроить параметры, такие как temperature и 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 package. Initialize the client with the custom base URL. Pass your API key. The syntax mirrors the Python example. This consistency reduces debugging time. You can send multiple messages in a conversation history array.

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. Обработка ошибок критична для приложений уровня production. Отлавливайте сетевые ошибки и ошибки 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 никогда не использует ваши промпты для обучения. Конфиденциальность сохраняется. Кредиты не истекают.