メインコンテンツへスキップ
POST

承認

Authorization
string
header
必須

すべてのリクエストは API キーで認証します：Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します（Dify API クイックスタート）。

キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーがない、または無効な場合は HTTP 401（unauthorized）が返ります。

ボディ

application/json

テキスト生成メッセージを作成するためのリクエストボディ。

inputs
object
必須

アプリの入力変数の値を、変数名をキーとして指定します。期待される名前と型は、アプリケーションのパラメータ情報を取得 の user_input_form フィールドで確認できます。

user
string
必須

エンドユーザーの識別子。アプリ側で定義し、アプリ内で一意にします。メッセージとファイルは、同じ user を指定したリクエストからのみ参照できます。エンドユーザーの識別 を参照してください。

query
string
デフォルト:""

処理するテキストです。レガシーフィールドで、新しいアプリではこの値を inputs の中で渡します。

response_mode
enum<string>

レスポンスモードです。省略時は blocking になります。

  • streaming（推奨）：サーバー送信イベント（SSE）でレスポンスを返します。
  • blocking：生成が完了してから返します。

生成に時間がかかる場合は streaming を使用してください。blocking を使う場合は、リバースプロキシやゲートウェイのタイムアウトを最長の生成時間より長く設定してください。

利用可能なオプション:
streaming,
blocking
files
object[]

リクエストに添付するファイルです。ローカルファイルの場合は、まず ファイルをアップロード でアップロードし、返された id を upload_file_id として transfer_method: local_file で参照します。

レスポンス

リクエスト成功。コンテンツタイプと構造はリクエストの response_mode パラメータに依存します。

  • response_mode が blocking の場合、 application/json で CompletionResponse オブジェクトを返します。
  • response_mode が streaming の場合、 text/event-stream で ChunkCompletionEvent オブジェクトのストリームを返します。
event
string

イベントタイプ。message に固定されています。

task_id
string<uuid>

タスク ID です。リクエストの追跡と、完了メッセージの生成を停止 API の呼び出しに使います。

id
string<uuid>

このレスポンスイベントの一意 ID です。

message_id
string<uuid>

一意のメッセージ ID です。フィードバックや推奨質問のエンドポイントを呼び出す際に message_id パラメータとして使用します。

mode
string

アプリモード、completion 固定です。

answer
string

完全なレスポンスコンテンツ。

metadata
object

使用量と検索リソースを含むメタデータ。

created_at
integer<int64>

メッセージ作成タイムスタンプ（Unix エポック秒）。