Документация API Ollama для разработчиков

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

Использовать https://api.ollamaendpointurl.com/v1 в качестве базового URL и укажите ваш API-ключ в Authorization Заголовок.

• Базовый URL: https://api.ollamaendpointurl.com/v1
• Заголовок: Authorization: Bearer YOUR_API_KEY

Сгенерируйте свой ключ мгновенно через Google или электронную почту на панели управления. Номер телефона не требуется. Этот URL работает с любым стандартным SDK OpenAI путем переопределения базового URL.

Первый запрос

Отправьте POST-запрос на /v1/chat/completions с идентификатором модели uncensored и ваши сообщения.

Copycurl https://api.ollamaendpointurl.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "What is the default port for Ollama?"}]
  }'

Это возвращает ответ JSON, содержащий сгенерированный текст. Если вы получаете ошибку 401, ваш API-ключ недействителен. Ошибка 402 указывает на недостаточный предоплаченный баланс.

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

Инициализируйте клиент, передав ключ и пользовательский базовый URL для отправки запросов программно.

Copyfrom openai import OpenAI

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

Установить max_tokens для контроля длины вывода. Без него значение по умолчанию составляет 2 048 токенов. Модель принимает стандартные параметры, такие как temperature и top_p для настройки поведения генерации.

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

Настройте Node.js клиент так, чтобы он указывал на наш конечный пункт для бесшовной интеграции в ваши скрипты.

Copyimport OpenAI from "openai";

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

SDK автоматически обрабатывает сериализацию. Убедитесь, что вы используете последнюю версию SDK OpenAI, поддерживающую пользовательские базовые URL. Ошибки выбрасываются как стандартные исключения API.

Потоковые ответы

Включите потоковую передачу, установив stream: true получать токены через Server-Sent Events (SSE).

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)

Подробности об использовании токенов появляются в последнем чанке потока. Это снижает воспринимаемую задержку для длинных выводов. Конечная точка поддерживает стандартное форматирование SSE, совместимое с большинством клиентских библиотек.

Лимиты запросов и контекстное окно

Каждый API-ключ ограничен 300 запросами в минуту и 8 параллельными запросами. Размер контекстного окна составляет 100,000 токенов в общей сложности. Максимальный объем вывода на запрос составляет 16,000 токенов. Запросы с размером тела более 8 МБ отклоняются. Ошибка 429 указывает на достижение лимита частоты запросов. Подождите немного перед повторной попыткой. Ошибки и отказы не расходуют кредит. Кредит не истекает. Используйте криптовалюту для пополнения. Начните с пробного кредита на $0.50. Получите свой ключ сейчас.