workflow モードで動作します。呼び出しごとに公開済みのワークフローを 1 回実行し、その出力を返します。呼び出し間で会話状態を保持しないため、各実行は独立しています。
認証、ベース URL、エンドユーザーごとにデータを区分する
user フィールドについては、クイックスタート と エンドユーザーの識別 を参照してください。ワークフローの実行
- ワークフローを実行：指定した入力変数で、アプリの現在公開中のワークフローを実行します。 ストリーミングモードでは、ノードの実行に合わせてイベントをリアルタイムに受け取れます。ブロッキングモードでは、実行が完了してから結果を返します。
-
ID でワークフローを実行：特定の公開バージョンを実行します。
workflow_idは、以前の実行レスポンスや実行詳細の取得結果にあります。
実行の追跡と制御
どちらのモードでも、レスポンスには 2 つの ID が含まれます。task_id は実行中のタスクを制御し、workflow_run_id は実行後に保存される記録を識別します。
- ワークフロータスクを停止：
task_idを指定して実行中のタスクを取り消します。ストリーミングモードでのみ有効です。ブロッキングモードでは、レスポンスが返る時点で実行が完了しているため取り消せません。
実行履歴の確認
- ワークフロー実行詳細を取得：指定した
workflow_run_idの実行ステータスと出力を返します。 - ワークフローログ一覧を取得：ステータス、token 使用量、ステップ数、所要時間を含む実行単位のサマリーを返します。ノード単位の実行ログではありません。キーワード、ステータス、期間、実行を開始したユーザーで絞り込めます。
ファイルの操作
- ファイルをアップロード：画像、ドキュメント、音声、動画ファイルをアップロードします。ワークフローの実行時に、ファイル型の入力変数へ返された
idをupload_file_idとして渡します。ファイルはアップロードしたエンドユーザーのみが利用できます。
音声とテキストの相互変換
- 音声をテキストに変換：アップロードされた音声ファイル（MP3、M4A、WAV、AMR、MPGA のいずれか、最大 30 MB）を文字起こしします。エンドユーザーは入力値をタイピングの代わりに音声で入力できます。
- テキストを音声に変換：ワークフローのテキスト出力を音声として合成します。
アプリ情報と設定の取得
- アプリケーションの基本情報を取得：アプリの名前、説明、タグ、モードを返します。
- アプリケーションのパラメータ情報を取得：呼び出し時に
inputsで送るフィールド（名前、型、デフォルト値）と、アプリの機能スイッチを返します。リクエストやクライアント UI を構築する際の基礎になります。 - アプリケーションのメタ情報を取得：ツールアイコンなどの設定メタデータを返します。
- アプリの Web アプリ設定を取得：Web アプリのサイト設定、テーマ、カスタマイズ項目を返します。