Open API
自社システムからエージェントを呼び出す
チケット管理システム、CRM、社内ツールから、Evose で公開したエージェントやワークフローを呼び出せます。結果を待つことも、実行 ID だけ先に受け取り、完了時にコールバックを受けることもできます。
今あるシステムにつなぐ
チームがつくったものを呼び出す
チームが Evose で公開したエージェント、オーケストレーションエージェント、ワークフローは、どれも API から呼び出せます。呼び出しには最新の公開バージョンが使われるので、Evose でプロンプトを変えてもコードの修正は不要です。
長いタスクも待たずに済む
非同期で実行すると、実行 ID がその場で返ります。ID で結果を取得することも、コールバック URL を渡して完了時に通知を受けることもできます。
用途ごとに 1 つの Key
各 API Key が呼び出せるのは、指定したアプリだけです。有効期限を設定でき、いつでも無効にできます。
公開から最初の呼び出しまで
- 01
アプリを公開
Evose でエージェント、オーケストレーションエージェント、ワークフローをつくります。公開すれば API から呼び出せます。
- 02
API Key を作成
Key の所属と呼び出せるアプリを選び、自社のサービスに組み込みます。
- 03
呼び出す
結果を待つか、非同期で実行して実行 ID を控え、完了時にコールバックを受け取ります。
エンドポイント
すべてのエンドポイントは /open/v1 配下にあります。リクエストヘッダーで API Key を Bearer トークンとして渡して認証します。
アプリ
- GET
/appsこの Key で呼び出せるアプリの一覧を取得 - GET
/apps/agent/{app_id}/configエージェントまたはオーケストレーションエージェントの呼び出し設定を取得 - GET
/apps/workflow/{app_id}/configワークフローの入力変数を取得
エージェントとオーケストレーションエージェント
- POST
/apps/agent/run会話を開始(ストリーミング対応) - POST
/apps/agent/async-run非同期実行を開始(コールバック URL は任意) - GET
/apps/agent/async-runs/{run_id}非同期実行のステータスと回答を取得
ワークフロー
- POST
/apps/workflow/runワークフローを実行し、進捗をイベントでストリーミング - POST
/apps/workflow/sync-runワークフローを実行し、最終出力を待つ - POST
/apps/workflow/async-run非同期実行を開始(コールバック URL は任意) - GET
/apps/workflow/async-runs/{run_id}非同期実行の結果を取得
ファイル
- POST
/files/upload実行の入力に使うファイルをアップロード
活用例
新しいチケットを振り分ける
新しいチケットが届くたびに振り分けエージェントを呼び出し、提案をチケットに書き戻します。
プロンプト “このチケットの緊急度を判定し、担当すべきチームを提案してください。提案欄だけを埋め、お客様には返信しないでください。”
CRM でフォローメールを下書き
営業担当がボタンを押すと CRM がエージェントを呼び出し、直近のやりとりからメールを下書きします。
プロンプト “直近 3 回のやりとりをもとに、この商談のフォローメールを営業担当本人の口調で下書きしてください。値引きは約束せず、下書きのまま担当者の確認を待ってください。”
夜間に突き合わせる
定時ジョブがワークフローを呼び出し、朝には例外リストがそろいます。
プロンプト “今日の注文エクスポートを在庫表と突き合わせ、在庫が 7 日分を切る商品を一覧にしてください。一覧の作成だけで、発注はしないでください。”
Key ごとに呼び出せる範囲を決める
API Key は、Evose のメンバー権限とは別に管理します。
- 指定したアプリだけKey を作成するときに、所属と呼び出せるアプリを選びます。範囲外の呼び出しは拒否されます。
- 有効期限と無効化有効期限を設定でき、いつでも Key を無効にしたり削除したりできます。一覧では各 Key の最終使用日時を確認できます。
- Key ごとの使用量「観測」で、Key ごとのコストとクォータの使用量を個別に確認できます。