Workflow アプリ API

このドキュメントは AI によって自動翻訳されています。不正確な部分がある場合は、英語版を参照してください。

Workflow アプリは workflow モードで動作します。呼び出しごとに公開済みのワークフローを 1 回実行し、その出力を返します。呼び出し間で会話状態を保持しないため、各実行は独立しています。

認証、ベース URL、エンドユーザーごとにデータを区分する user フィールドについては、クイックスタートとエンドユーザーの識別を参照してください。

ワークフローの実行

ワークフローを実行：指定した入力変数で、アプリの現在公開中のワークフローを実行します。ストリーミングモードでは、ノードの実行に合わせてイベントをリアルタイムに受け取れます。ブロッキングモードでは、実行が完了してから結果を返します。
ID でワークフローを実行：特定の公開バージョンを実行します。workflow_id は、以前の実行レスポンスや実行詳細の取得結果にあります。

どちらのモードでも、レスポンスには 2 つの ID が含まれます。task_id は実行中のタスクを制御し、workflow_run_id は実行後に保存される記録を識別します。

ワークフロータスクを停止：task_id を指定して実行中のタスクを取り消します。ストリーミングモードでのみ有効です。ブロッキングモードでは、レスポンスが返る時点で実行が完了しているため取り消せません。
ワークフローイベントをストリーム：接続の切断後や一時停止後に、workflow_run_id からイベントストリームを再開します。 include_state_snapshot=true を指定すると、実行済みノードの状態を先に再生します。continue_on_pause=true を指定すると、複数回の人間の入力による一時停止をまたいでストリームを維持できます。

配信方法に WebApp を指定した人間の入力ノードに実行が到達したら、API で一時停止を完了させます。

一時停止の検知

実行のイベントストリームが form_token と実行の workflow_run_id を含む human_input_required を発行します。その後、ストリームは workflow_paused イベントで終了します。

フォームの取得

form_token を使い、人間の入力フォームを取得でフォームの内容を読み込みます。

回答の送信

人間の入力フォームを送信で受信者の入力内容を送信します。送信すると実行が再開します。

ストリームの再開

一時停止したストリームの workflow_run_id を使い、ワークフローイベントをストリームで新しいストリームを開きます。実行完了までの残りのイベントを追跡します。

ファイルを添付した送信と完全なイベントシーケンスについては、人間の入力フローガイドを参照してください。

ワークフロー実行詳細を取得：指定した workflow_run_id の実行ステータスと出力を返します。
ワークフローログ一覧を取得：ステータス、token 使用量、ステップ数、所要時間を含む実行単位のサマリーを返します。ノード単位の実行ログではありません。キーワード、ステータス、期間、実行を開始したユーザーで絞り込めます。

ノード単位のイベントが必要な場合は、ログではなく実行自体をストリームします。新しく開始する実行は、ワークフローを実行をストリーミングモードで呼び出します。進行中の実行には、ワークフローイベントをストリームを使用します。

ファイルをアップロード：画像、ドキュメント、音声、動画ファイルをアップロードします。ワークフローの実行時に、ファイル型の入力変数へ返された id を upload_file_id として渡します。ファイルはアップロードしたエンドユーザーのみが利用できます。
エンドユーザー取得：エンドユーザー ID（ファイルアップロードのレスポンスにある created_by など）から、そのユーザーの詳細を取得します。

音声をテキストに変換：アップロードされた音声ファイル（MP3、M4A、WAV、AMR、MPGA のいずれか、最大 30 MB）を文字起こしします。エンドユーザーは入力値をタイピングの代わりに音声で入力できます。
テキストを音声に変換：ワークフローのテキスト出力を音声として合成します。

アプリケーションの基本情報を取得：アプリの名前、説明、タグ、モードを返します。
アプリケーションのパラメータ情報を取得：呼び出し時に inputs で送るフィールド（名前、型、デフォルト値）と、アプリの機能スイッチを返します。リクエストやクライアント UI を構築する際の基礎になります。
アプリケーションのメタ情報を取得：ツールアイコンなどの設定メタデータを返します。
アプリの WebApp 設定を取得：WebApp のサイト設定、テーマ、カスタマイズ項目を返します。