STORYAI API を使うと、Web画面で行っている作品の登録・分析・結果の取得を、お客様のシステムやスクリプトから実行できます。この記事では、APIでできること、利用できる条件、APIキーの発行と管理を説明します。リクエストの書き方は「APIドキュメント」をご覧ください。
APIでできること
- 作品の登録と分析: ファイルまたはテキストを送り、Web画面と同じ分析を始めます。
- 版の追加: 修正した原稿を同じ作品の新しい版として分析します。Web画面の「新しい版を追加」と同じ操作です。
- 再分析: 作品の最新の版をもう一度分析します。
- SNS投稿の時系列分析: 複数の投稿を投稿順にまとめて1つの作品として分析します。
- 作品一覧・分析結果の取得: 総合評価や感情分析の結果をJSONで受け取ります。グラフ画像のURLも取得できます。
- 分析状況の通知: WebSocketで接続すると、分析の完了・失敗をすぐに受け取れます。
APIから登録した作品は、Web画面の作品一覧にも表示されます。グラフの確認や比較は、Web画面で行う作品と同じように使えます。
活用例
- 夜間のバッチ処理で、たくさんの原稿をまとめて分析する
- CMSや制作管理ツールから原稿を自動で送り、結果を社内のダッシュボードに貯める
- ゲームエンジンなどの制作環境から離れずに分析する
ゲームエンジンとの連携例は、CEDEC2025での発表をご覧ください。 【CEDEC2025】感情分析AIによるゲーム制作におけるプリビズの進化への提示
利用できる条件
APIキーを発行するには、次の3つをすべて満たす必要があります。発行画面にも同じ3つのステップが表示され、満たした項目には「クリア」が付きます。未達の項目には、登録する画面へのリンクが表示されます。
| ステップ | 画面の表示 | 内容 |
|---|---|---|
| ① | 「①オーナー/システム管理者のみ利用可能」 | ブランドでの役割が「オーナー」か「システム管理者」であること。一般ユーザーには「API」タブ自体が表示されません。 |
| ② | 「②課金プランに登録必須」 | 有料プラン、または法人契約であること。無料プランでは発行できません。 |
| ③ | 「③会社情報の詳細情報登録必須」または「③支払い情報の詳細情報登録必須」 | 契約の種類によって表示が変わります。会社情報の場合は、会社名・法人番号・担当者名・役職・Webサイト・住所・電話番号をすべて入力します。支払い情報の場合は、登録済みカードのカード名義・国・住所・市区町村・都道府県を入力します。 |
ブランドでの役割は「アカウント設定」の「メンバー」タブで確認できます。役割の変更はオーナーかシステム管理者が行います。
APIキーを発行する
- 左メニューの「設定」を開きます。「アカウント設定」画面が開きます。
- 「API」タブを選び、「STORYAI API」を表示します。
- 「APIキー発行」の3つのステップがすべて「クリア」になっていることを確かめます。
- 「APIキーを作成」を押します。
- 「APIキー表示名」に用途がわかる名前（例: 開発用キー）を入力し、「キーを作成」を押します。
- 一覧に追加されたキーの行にあるコピーのアイコンを押すと、キーがクリップボードにコピーされます。
キーの管理
- 作成できる数: 1人につき、ブランドごとに3個までです。4個目を作ろうとすると「APIキーは最大3個までです。」と表示されます。
- ブランド内のすべてのキーが表示されます: オーナー・システム管理者には、他のメンバーが発行したキーも一覧に表示されます。「発行者」の列で、誰が発行したキーかを確認できます。自分のキーは「あなた」、退会などで削除されたユーザーのキーは「削除済みのユーザー」と表示されます。
- 表示とコピー: 一覧ではキーの先頭5文字だけが表示されます。自分が発行したキーは、コピーのアイコンでいつでもキー全体をコピーできます。他のメンバーが発行したキーは、値が表示されず、コピーもできません。
- 名前の変更: 自分が発行したキーだけ、行末の「…」から「名称を変更」を選べます。表示名だけが変わり、キー自体は変わりません。
- 削除: 行末の「…」から「削除」を選びます。他のメンバーが発行したキーも削除できます。その場合は「（名前） さんが発行したAPIキーです。削除すると、このキーを使った連携はすぐに使えなくなります。」と確認されます。削除は取り消せません。削除したキーはすぐに使えなくなります。
- 有効期限: キーに有効期限はありません。一時停止の機能もないため、使わなくなったキーは削除してください。
安全に使うために
- APIキーを使うと、キーを発行したブランドのすべての作品を登録・取得できます。Web画面のプロジェクトごとの権限（管理者・編集者・閲覧者）による絞り込みはかかりません。
- APIで登録した作品は、キーを発行した人が作成した作品として記録されます。
- キーをソースコードや公開リポジトリに含めないでください。
- 漏れた疑いがあるときは、すぐにそのキーを削除し、新しいキーを発行してください。
- キーは使うたびに、発行時の条件を満たしているか確認されます。次の場合、そのキーは使えなくなり、APIはエラー（403）を返します。
- キーを発行した人をブランドのメンバーから外した
- キーを発行した人の役割を、オーナー・システム管理者から一般ユーザーへ変えた
- ブランドのプランを、APIを利用できないプラン（無料プランなど）へ変えた
- 役割やプランを元に戻すと、同じキーを再び使えます。確実に止めたいキーは、オーナー・システム管理者が一覧から削除してください。
- 担当者が替わるときは、新しい担当者がキーを発行し直し、前の担当者のキーを削除してください。
利用回数について
- APIからの作品登録と版の追加は、Web画面と同じ「作品分析」の月間回数を1回ずつ使います。回数はブランド全体で共通です。
- 上限に達すると、登録と版の追加はエラー（429）になります。
- 再分析と結果の取得では回数を使いません。
- 残りの回数は、左メニューの「今月の利用上限」にある「作品分析」で確認できます。上限は契約内容によって異なります。プランの内容は「サブスクリプション」画面でご確認ください。