Быстрый старт интеграции Character api

Установите SDK

Начните с установки официальной клиентской библиотеки для вашего языка. Это обеспечивает совместимость с предоставляемым нами эндпоинтом, совместимым с OpenAI. Библиотека берет на себя сериализацию и логику повторных попыток.

Для Python используйте pip. Для Node.js используйте npm. Этот шаг занимает несколько секунд и настраивает среду для следующих примеров кода.

Настройте ваш базовый URL

Укажите базовый URL нашего SDK-клиента для нашего эндпоинта, чтобы получить доступ к uncensored-модели. Базовый URL — HTTPS://api.apicharacter.com/v1. Это заменяет стандартный URL OpenAI в вашей конфигурации.

Без этого изменения запросы будут завершаться ошибкой или попадать не на тот сервис. Вам нужно установить это только один раз при инициализации экземпляра клиента.

Установить ваш API ключ

Вставьте ваш ключ в переменную окружения или конфигурацию клиента. Аутентификация требуется для каждого запроса для отслеживания использования предоплаченных кредитов. Ваш ключ предоставляет доступ к эндпоинту uncensored LLM.

Храните это значение в безопасности. Оно служит вашим единственным удостоверением личности для аккаунта. Для базового доступа не требуется номер телефона или дополнительная верификация.

Сделайте свой первый запрос

Отправьте простой запрос на завершение чата, чтобы проверить подключение. Идентификатор модели — "uncensored". Это подтверждает, что ваша аутентификация и базовый URL корректны, прежде чем вы начнете разрабатывать приложение.

Посмотрите пример стандартного запроса cURL ниже.

Copycurl https://api.apicharacter.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "set my name to Alex"}]
  }'

Обрабатывайте потоковые ответы

Включите потоковую передачу для снижения задержки в ваших чат-интерфейсах. Установите параметр stream в true в своем запросе. SDK будет выдавать токены по мере их генерации.

Это критически важно для отзывчивого пользовательского опыта. Вы обрабатываете частичные фрагменты по мере их поступления через Server-Sent Events.

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 токенов, если не указано иное.

Лимит запросов составляет 300 запросов в минуту. Ошибка 401 означает недействительный ключ. Ошибка 402 означает нулевой баланс. Ошибка 429 означает превышение лимита. Учитывайте это при масштабировании в продакшене.

Python

Copyfrom openai import OpenAI

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

Copyimport OpenAI from "openai";

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