Chatflow アプリ API

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

Chatflow アプリは advanced-chat モードで動作します。返信とあわせて、ワークフローレベルのイベント（ノードの開始、完了、イテレーション、一時停止）をストリーミングします。それまでの会話内容はコンテキストとして保持され、後のメッセージから参照できます。

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

メッセージの送信とストリーミング返信

チャットメッセージを送信：Chatflow アプリに質問を送信します。ストリーミングモードでは、回答テキストとあわせてワークフローイベントとノードイベントが届きます。ブロッキングモードでは、実行が完了してから結果を返します。
生成を停止：ストリーミング中の返信を完了前に中断します。
次の推奨質問を取得：返信の完了後に、それまでの会話内容をもとに次の質問を提案します。

ファイルをアップロード：画像、ドキュメント、音声、動画ファイルをアップロードし、チャットメッセージを送信から参照できるようにします。ファイルはアップロードしたエンドユーザーのみが利用できます。
ファイルをダウンロード：アップロード済みファイルをプレビューまたはダウンロードします。対象はアプリ内のメッセージに紐づくファイルに限られます。
エンドユーザー取得：エンドユーザー ID（ファイルアップロードのレスポンスにある created_by など）から、そのユーザーの詳細を取得します。

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

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

一時停止の検知

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

フォームの取得

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

回答の送信

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

ストリームの再開

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

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

ワークフロー実行詳細を取得：workflow_run_id を指定して、実行のステータスと出力を取得します。この ID は、チャット返信とあわせてストリーミングされるワークフローイベントとノードイベントに含まれます。
ワークフローログ一覧を取得：ステータス、token 使用量、ステップ数、所要時間を含む実行単位のサマリーを返します。ノード単位の実行ログではありません。

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

アノテーションは質問と固定回答をペアにします。一致した場合、アプリは新しい回答を生成せず、固定回答をそのまま返します。