Документация для ключа openai compatible api

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

Используйте сгенерированный ключ с предоставленным базовым URL для мгновенного подключения. Конечная точка https://api.openaicompatibleapikey.com/v1 и работает с любым клиентом, совместимым с OpenAI. Вы получаете один активный ключ на учетную запись; генерация нового заменяет старый. Аутентификация обрабатывается через Authorization Заголовок со значением Bearer схему. Для регистрации не требуется номер телефона, и вы можете начать с бесплатного пробного кредита на $0.50.

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

Отправьте простое завершение, чтобы проверить подключение и uncensored-модель. Запрос использует стандартный POST /v1/chat/completions эндпоинт с идентификатором модели, установленным на uncensored. Это подтверждает, что ваш API-ключ действителен и конечная точка доступна, прежде чем вы интегрируете ее в свое приложение. Ответ включает использование токенов и сгенерированный текст.

Copycurl https://api.openaicompatibleapikey.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Calculate the total price including tax"}]
  }'

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

Подключите API к вашим проектам на Python, переопределив базовый URL по умолчанию. Это позволяет использовать официальный openai библиотекой с нашим uncensored LLM без изменения логики вашего кода. Передайте ваш API key и конкретный base URL в инициализацию клиента. ID модели остается uncensored для всех запросов.

Copyfrom openai import OpenAI

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

Подключите свои приложения на Node.js, установив baseURL и apiKey свойства. Это обеспечивает совместимость с существующим кодом клиентов, совместимым с OpenAI. Вы можете продолжать использовать стандартные параметры, такие как messages и model. Клиент будет маршрутизировать запросы на наши размещенные серверы для генерации uncensored-ответов.

Copyimport OpenAI from "openai";

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

Потоковая передача ответов и использование токенов

Включите потоковую передачу, установив stream: true в параметрах запроса. API возвращает события серверных событий (SSE) для доставки токенов в реальном времени. Детали использования токенов включены в последний фрагмент потока. Это позволяет вам отслеживать расходы и использование контекста по мере генерации текста. Модель поддерживает контекстное окно объемом 100,000 токенов.

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)

Лимиты скорости, ошибки и ограничения

Отслеживайте квоту, чтобы избежать прерывания службы. Лимит составляет 300 запросов в минуту на ключ и 8 одновременных запросов. Ошибка 401 указывает на недействительный ключ, а 402 сигнализирует о недостатке кредитов. Ошибки и отказы бесплатны. Контекстное окно составляет 100,000 токенов, с максимальным выводом 16,000 токенов на запрос. Кредиты не имеют срока действия.