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 をタップするか、画像に /animate <動かし方> で返信します。
• キャラクターとのチャット: プライベートチャットで入力するか、/talk を使います。返信は 1 つのメッセージにストリーミングされます。
• 支出の保護: 各リクエストは先に料金が提示され（見積もりは無料）、高額なものは Confirm のタップが必要で、1 人あたりとボット全体の 1 日の上限も適用されます。
• 既定で非公開: あなたが許可するまで、ほかの誰も使えません。

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 なら、自分のサーバーなしでボットを動かせます。ワンクリックのテンプレートはなく、自分のリポジトリのコピーからデプロイします。

サービスはレプリカ 1 つのままにしてください。同じ Telegram トークンをポーリングするコピーが 2 つあると、更新を奪い合います。ボットには、公開ドメインも開放するポートも不要です。

Discord を追加する（任意）

Discord は、年齢制限付きコマンドを持つアプリを App Directory に載せることを認めていないため、ボットは非公開のままにしてください。.env.example には DISCORD_MEDIA_IN_DMS もあり、既定は false です。この場合、画像と動画は、年齢制限付きのサーバーチャンネルでのみ動作し、ダイレクトメッセージでは動作しません。

誰が使えるか

ボットを見つけた見知らぬ人には、非公開であることと、あなたに送るためのユーザー ID が案内されます。グループは ALLOWED_CHAT_IDS に登録するまで無視されます。登録したグループでは、メンバー全員が、1 日の上限の範囲内でボットを使えます。Telegram のグループ ID は、-1001234567890 のように負の数です。

このボットを運用するのはあなたで、誰に使わせるかについての責任もあなたにあります。SpicyAPI の利用規約が適用され、これには SpicyAPI がサービスを提供しない地域も含まれます。

支出の仕組み

1. 先に料金を提示。 画像や動画は、何かが起きる前に SpicyAPI が見積もりを出します。見積もりは無料です。
2. 絶対的な上限。 リクエストが MAX_COST_PER_REQUEST_USD（既定 $1）を超える可能性がある場合は拒否されます。何も課金されません。
3. 確認。 CONFIRM_ABOVE_USD（既定 $0.10）を超える可能性がある場合、ボットは料金を表示して Confirm と Cancel のボタンを出します。確認できるのは、リクエストした本人だけです。
4. 1 日の上限。 1 人あたり UTC の 1 日に USER_DAILY_BUDGET_USD（既定 $1）、ボット全体で DAILY_BUDGET_USD（既定 $5）まで使えます。実行中の生成は終わるまで使用済みとして数えるため、複数のリクエストを同時に出しても上限をすり抜けられません。オーナーは、ボット全体の上限だけが対象です。
5. 二重課金なし。 各リクエストには、チャットメッセージまたはボタンのタップから導いた冪等キーが付くため、Telegram の更新が重複したりダブルタップしたりしても、すでに存在するタスクが返ります。
6. 結果。 進行状況は、数秒ごとに 1 つのメッセージを編集して表示されます。結果には、実際の課金額とタスク ID が表示され、コンソールの Logs で調べられます。

受理済みの生成はキャンセルできません。成功した実行は課金され、通常の失敗では仮押さえ額が解放されます。一部のコンテンツ拒否は、モデルページに明記されている場合に限り課金されます。課金を参照してください。

上限付きのキーを使う

ボットは、独自の台帳を DATA_DIR/state.json に保持します。このファイルが失われると、ボットは今日使った金額を忘れます。コンソールの API キーに設定した上限は、SpicyAPI が適用するため、決して失われない上限です。ボット専用のキーを作成して 1 日の支出上限を設定し、必要なら使いたいモデルだけを許可してください。上限に達すると、ボットはキーが支出上限に達したことを知らせます。

そのほかの便利な設定です。

モデルと料金

各ユーザーは /models でモデルを変更できます。既定値は運用者が設定します。

正確なモデル ID は .env.example にあります。切り替えるには、ライブカタログ（GET /api/v1/models）から別の ID をコピーします（下のキャラクターの例では、MODEL_ID_FROM_CATALOG がそうした ID を入れる位置を示しています）。料金は公開カタログのもので、変わることがあります。ボットは常に最新の見積もりを表示します。モデルは spicyapi.ai/models で見るか、モデルを参照してください。ロールプレイ向けのチャットモデル選びには、ロールプレイのリーダーボードが役立ちます。

キャラクター

キャラクターは JSON ファイル（CHARACTERS_FILE、既定は characters/default.json で、2 人のサンプルキャラクターが入っています）に定義します。

{
  "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 のファイルリンクにはボットのトークンが含まれるため、先には渡されません。

プライバシー: 何がどこに保存されるか

アカウントの既定より早く結果とプロンプトを削除するよう SpicyAPI に依頼するには、RETENTION_SECONDS を設定します。

グループでは、結果がスポイラーの陰に隠されます（SPOILER_MEDIA、既定は groups。ほかの値は always と never）。/report は、メッセージをオーナーに転送します。SpicyAPI のルールに違反するコンテンツは、spicyapi.ai/abuse でも報告できます。

トラブルシューティング

エラーコードの意味はエラーで説明しています。