Бот для Telegram и Discord

Бот SpicyAPI — это небольшая программа, которую вы запускаете сами. Она подключается к Telegram (и, если хотите, к Discord) и позволяет тем, кому вы разрешили, создавать изображения, делать видео, превращать изображения в видео и общаться с заданными вами персонажами. Всё оплачивается с вашего баланса SpicyAPI, а цена каждого запроса рассчитывается до любого списания.

Бот бесплатный и с открытым исходным кодом (MIT): github.com/spicyapi-ai/spicyapi-bot. По умолчанию он приватный: им можете пользоваться только вы, пока не разрешите другим людям или группам.

Что умеет бот

• Изображения: /pic a lighthouse at dusk
• Видео: /vid waves rolling onto a beach at sunset
• Анимация: нажмите Animate под любым изображением, которое создал бот, или ответьте на него командой /animate <how it should move>.
• Чат с персонажем: пишите в личном чате или используйте /talk. Ответы поступают потоком в одно сообщение.
• Защита от лишних трат: каждый запрос сначала оценивается по цене (расчёты бесплатны), дорогие запросы требуют нажатия Confirm, а суточные лимиты действуют и на каждого человека, и на весь бот.
• Приватность по умолчанию: никто другой не может им пользоваться, пока вы не разрешите.

В каталоге SpicyAPI есть модели без цензуры, которые не добавляют собственного фильтра содержимого, и бот работает с любой выбранной вами моделью. К тому, что вы создаёте, по-прежнему применяются закон и политика содержимого SpicyAPI. См. Политика.

Команды

Названия намеренно не /image, /video или /chat, которые используют другие популярные боты, чтобы этот бот мог находиться в одной группе с ними. В группе Telegram отвечайте на одно из сообщений чата бота, чтобы продолжать разговор с персонажем.

Перед началом

• Компьютер или сервер, который всегда включён, с установленным Docker. (Или аккаунт Railway, см. ниже.)
• Аккаунт SpicyAPI с балансом. См. Подготовка аккаунта и Оплата.
• Аккаунт Telegram, чтобы создать бота через BotFather.

Развёртывание через Docker Compose

git clone https://github.com/spicyapi-ai/spicyapi-bot.git
cd spicyapi-bot
cp .env.example .env

SPICY_API_KEY=sk-spicy-...
TELEGRAM_BOT_TOKEN=123456789:AA...
OWNER_ID=your-telegram-user-id

docker compose up -d

docker compose up -d --build
docker compose logs -f

Чтобы обновить бота позже, выполните git pull && docker compose up -d --build.

Развёртывание на Railway

Railway может запускать бота без собственного сервера. Шаблона в один клик нет: вы развёртываете из собственной копии репозитория.

Держите сервис в одной реплике: две копии, опрашивающие один и тот же токен Telegram, мешают друг другу получать обновления. Боту не нужны ни публичный домен, ни открытый порт.

Добавьте Discord (необязательно)

Discord не допускает в свой App Directory приложения с возрастными командами, поэтому оставьте бота приватным. В .env.example есть также DISCORD_MEDIA_IN_DMS, по умолчанию false: изображения и видео тогда работают только в каналах серверов с возрастным ограничением, но не в личных сообщениях.

Кто может им пользоваться

Посторонним, нашедшим бота, сообщается, что он приватный, и выдаётся их user ID, чтобы они прислали его вам. Группы игнорируются, пока их нет в ALLOWED_CHAT_IDS; после добавления группы бота может использовать каждый её участник в пределах суточных лимитов. ID групп Telegram отрицательные, например -1001234567890.

Этого бота запускаете вы, и вы отвечаете за то, кому разрешаете им пользоваться. Действуют условия SpicyAPI, включая перечень регионов, которые SpicyAPI не обслуживает.

Как расходуются деньги

1. Сначала цена. Каждое изображение или видео оценивается SpicyAPI до того, как что-либо произойдёт. Расчёты бесплатны.
2. Жёсткий потолок. Если запрос может стоить больше MAX_COST_PER_REQUEST_USD (по умолчанию $1), он отклоняется. Ничего не списывается.
3. Подтверждение. Если запрос может стоить больше CONFIRM_ABOVE_USD (по умолчанию $0.10), бот показывает цену с кнопками Confirm и Cancel. Подтвердить может только тот, кто сделал запрос.
4. Суточные лимиты. Каждый человек может потратить USER_DAILY_BUDGET_USD (по умолчанию $1) за сутки по UTC, а весь бот — DAILY_BUDGET_USD (по умолчанию $5). Генерации, которые ещё выполняются, считаются потраченными до их завершения, поэтому несколько одновременных запросов не смогут проскочить лимит. На владельцев действует только лимит всего бота.
5. Никаких двойных списаний. Каждый запрос несёт ключ идемпотентности, полученный из сообщения чата или нажатия кнопки, поэтому дублированное обновление Telegram или двойное нажатие возвращает уже существующую задачу.
6. Результаты. Ход выполнения показывается правкой одного сообщения раз в несколько секунд. Результат показывает фактическое списание и идентификатор задачи, который можно найти в разделе Logs в консоли.

Принятую генерацию нельзя отменить. Успешные запуски оплачиваются, а при обычном сбое резерв освобождается. Некоторые отказы по содержимому оплачиваются только тогда, когда это прямо указано на странице модели. См. Оплата.

Используйте ключ с лимитом

Бот ведёт собственный журнал учёта в DATA_DIR/state.json. Если этот файл потерян, бот забывает, сколько потрачено сегодня. Лимит на API-ключе в консоли — это ограничение, которое потерять нельзя, потому что его обеспечивает SpicyAPI. Создайте для бота отдельный ключ, задайте суточный лимит расходов и при желании разрешите только нужные модели. Когда лимит достигнут, бот сообщит, что ключ достиг лимита расходов.

Другие полезные настройки:

Модели и цены

Каждый человек может менять свои модели командой /models. Значения по умолчанию задаёт оператор:

Точные идентификаторы моделей указаны в .env.example; чтобы переключиться, скопируйте другой идентификатор из актуального каталога (GET /api/v1/models; в примере персонажа ниже MODEL_ID_FROM_CATALOG отмечает место для такого идентификатора). Цены взяты из публичного каталога и могут меняться; бот всегда показывает актуальный расчёт. Просмотреть модели можно на spicyapi.ai/models или в разделе Модели. Для ролевых игр выбрать чат-модель поможет рейтинг для ролевых игр.

Персонажи

Персонажи хранятся в JSON-файле (CHARACTERS_FILE, по умолчанию characters/default.json, в котором два примера персонажей):

{
  "characters": [
    {
      "id": "mira",
      "name": "Mira",
      "system": "You are Mira, ... Never speak or act for {{user}}.",
      "greeting": "Welcome aboard, {{user}}!",
      "model": "MODEL_ID_FROM_CATALOG"
    }
  ]
}

• system — инструкции персонажа. greeting (необязательно) — его первая реплика. model (необязательно) закрепляет за этим персонажем чат-модель.
• {{char}} и {{user}} заменяются на имя персонажа и имя человека.
• Записи могут быть и в формате Character Card V2 JSON, который экспортируют большинство сайтов с персонажами и SillyTavern. Используются описание, характер, сценарий, пример диалога и первое сообщение.

В Docker смонтируйте свой файл и укажите его в настройке. В docker-compose.yml:

volumes:
  - ./my-characters.json:/app/characters/custom.json:ro

И в .env:

CHARACTERS_FILE=characters/custom.json

Бот помнит HISTORY_TURNS обменов репликами в каждом разговоре (по умолчанию 20) и ограничивает ответы CHAT_MAX_TOKENS токенами (по умолчанию 2048). Модели с рассуждением считают свои размышления в этот лимит, поэтому слишком маленькое значение может не оставить места для ответа. О том, как писать персонажей, см. Рецепты чата.

Загрузка фото по умолчанию выключена

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

Если вы зададите ALLOW_PHOTO_UPLOADS=true, любой, кому вы разрешили, сможет оживить отправленное фото. Включайте это только для людей, которым доверяете, и только для фотографий совершеннолетних, давших согласие. Когда это включено, загруженные изображения скачиваются ботом и хранятся в SpicyAPI. Ссылки на файлы Telegram никогда не передаются дальше, потому что в них содержится токен вашего бота.

Конфиденциальность: что где хранится

Задайте RETENTION_SECONDS, чтобы попросить SpicyAPI удалять результаты и промпты раньше срока по умолчанию для вашего аккаунта.

В группах результаты скрываются под спойлером (SPOILER_MEDIA, по умолчанию groups; другие значения — always и never). /report пересылает сообщение владельцу. О содержимом, нарушающем правила SpicyAPI, можно также сообщить на spicyapi.ai/abuse.

Устранение неполадок

Коды ошибок описаны в разделе Ошибки и повторы.