APIデプロイ

Agentriaでワークフロー（Workflow）を完成させたら、APIデプロイ（API Release）を通じてさまざまな業務に活用できます。APIとしてデプロイすると、外部システムからHTTPリクエストでこのワークフローを直接呼び出せます。

このガイドでは、新しいAPIをデプロイする方法と、デプロイの過程で一緒に設定するバージョン（Version）・APIキー（API Key）の設定方法をご案内します。

APIとは？

API（Application Programming Interface）は、異なるソフトウェアやサービス同士が標準化された方法でやり取りできるようにするインターフェースです。特定の機能やデータを外部に公開し、他のプログラムがそれを呼び出して活用できるようにします。例えば、OpenAI APIでテキスト生成機能を呼び出したり、Google Maps APIで地図データを取得したりするのも、すべてAPIを通じたやり取りです。

APIはリクエスト（Request）とレスポンス（Response）という形式で動作し、決められたルールに従ってデータをやり取りします。この仕組みにより、APIは単なるデータの通り道ではなく、システム間の再利用性と拡張性を支える重要な要素になっています。

AgentriaでワークフローをAPIとしてデプロイすると、そのワークフロー自体が1つのAPIになります。つまり、外部のバックエンドサーバーや別のサービスが、決められたリクエスト形式（エンドポイント・APIキー）に従って呼び出せば、ワークフローが実行され、その結果がレスポンスとして返ってきます。

APIを活用すると、次のようなメリットがあります。

• 再利用性： 一度デプロイしたワークフローを、複数の外部システムから繰り返し呼び出して再利用できます。

• 拡張性： 新しいサービスが増えても、同じAPI形式で連携を簡単に追加できます。

• 互換性： リクエスト・レスポンスの形式が標準化されているため、どの言語・プラットフォームで開発されたシステムからでも同じ方法で呼び出せます。

• 独立性： キャンバスでワークフローを直接実行しなくても、外部システムが必要なタイミングでAPIを呼び出し、結果を受け取れます。

事前準備

デプロイするワークフローがすでに完成している必要があります。バージョンを上げる基準が気になる方は、先に🔗バージョン管理ガイドをご確認ください。バージョンは、このガイドのデプロイ過程の中でその場で作成することもできます。

ステップ1：APIデプロイの開始

デプロイボタンをクリック

キャンバス右上のデプロイ（Deploy）ボタンをクリックします。

デプロイメニュー

メニューから+ 新規APIデプロイを選択します。すでにデプロイ済みのAPIがある場合は、既存のAPIデプロイ一覧から選択し、同じワークフローを別の名前で追加デプロイすることもできます。同じメニューからマーケット登録やMCPサーバーのデプロイも行えます。

ステップ2：API情報の入力

新規APIデプロイモーダル

新規APIデプロイウィンドウで、以下の情報を入力します。

ステップ3：バージョンの選択または作成

バージョン（Version）の項目で、このデプロイに使用するバージョンを選択します。

すでに作成済みのバージョンがあれば一覧から選択し、なければバージョンを追加を選択して、同じウィンドウ内でそのまま新しいバージョンを作成できます。Version番号とChange Logを入力し、作成ボタンをクリックするだけです。バージョン番号を上げる基準は🔗バージョン管理ガイドをご確認ください。

ステップ4：APIキーの選択または作成

APIキー選択の項目で、このAPI呼び出しに使用するAPIキーを指定します。

APIキー（API Key）は、外部からAPIを呼び出す際にリクエストを認証する、文字列ベースの認証情報です。以前に作成したキーがあれば、有効期限とともに一覧に表示され（無期限の場合は「有効期限：無期限」と表示されます）、その中から選んで再利用できます。新しく発行するには+ 新しいAPIキーを作成を選択し、キー名と（任意で）有効期限を入力して進めます。

APIキーの値は、発行直後のデプロイ完了画面で一度だけ全体が表示され、「キーをコピーして安全に保管してください。」という案内とコピーボタンが一緒に表示されます。それ以降はAPIキー選択の一覧に名前と有効期限のみが表示され、値は再度確認できなくなるため、画面を閉じる前に必ずコピーして安全な場所に保管してください。

ステップ5：デプロイの完了と情報の確認

バージョンとAPIキーまで選択したら、デプロイを完了します。既存のAPIキーを再利用する場合はそのままデプロイボタンをクリックし、+ 新しいAPIキーを作成を選んだ場合は次へボタンでキー名・有効期限の入力画面に進んでからデプロイボタンをクリックします。

新しくAPIキーを発行した場合、デプロイが完了するとAPIデプロイ完了！画面で、今作成したAPIキーの値を確認・コピーできます。この画面を閉じると値は二度と確認できなくなるため、コピーして完了ボタンでコピーしてから安全な場所に保管してください。

デプロイ後にAPI情報を確認・修正したい場合は、キャンバス右上のデプロイボタンをもう一度クリックします。既存のAPIデプロイ一覧の既存APIデプロイカードにある、以下の2つのボタンを使用できます。

API設定編集で確認したエンドポイントを実際に呼び出してテストしたい場合は、🔗Ability APIエンドポイントの使い方または🔗Agent APIエンドポイントの使い方ガイドをご確認ください。

次のステップ

APIデプロイが完了しました。

これで、発行されたエンドポイントとAPIキーを使って、外部システムからこのワークフローを直接呼び出せます。

• 🔗バージョン管理 — バージョンを上げる基準とロールバック方法をご確認ください。

• 🔗Ability APIエンドポイントの使い方 — デプロイしたアビリティAPIを外部から呼び出す方法を案内します。

• 🔗Agent APIエンドポイントの使い方 — デプロイしたエージェントAPIを外部から呼び出す方法を案内します。

よくある質問

APIとしてデプロイすると何ができますか？

完成したワークフローをAPIとしてデプロイすると、外部システムやサービスがHTTPリクエストでこのワークフローを直接呼び出し、結果を受け取れます。デプロイされたAPIは、エンドポイント名とAPIキーを使って呼び出します。

バージョンを事前に作成しておかなくてもデプロイできますか？

はい、可能です。APIデプロイウィンドウのバージョン項目でバージョンを追加を選択すると、別画面に移動することなく、その場で新しいバージョンを作成してすぐにデプロイに使用できます。

APIキーを複数のAPIで一緒に使ってもいいですか？

はい、可能です。APIキー選択の一覧には以前発行したキーが有効期限とともに表示され、その中から選んで別のAPIデプロイにも再利用できます。用途ごとに分けたい場合は、デプロイのたびに+ 新しいAPIキーを作成で新しいキーを発行してください。

APIキーを紛失した場合はどうすればいいですか？

APIキーは発行直後の画面でのみ全体の値を確認でき、画面を閉じると二度と確認できません。紛失した場合は、デプロイ → 既存のAPIデプロイ → API設定編集から新しいAPIキーに切り替えられます。