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

承認

Authorization
string
header
必須

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

キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401unauthorized)で失敗します。

ボディ

application/json

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

inputs
object
必須

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

user
string
必須

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

query
string
デフォルト:""

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

response_mode
enum<string>

レスポンスの返却モード。streaming(推奨)は SSE を使用します。blocking は完了後に返却します(長時間の処理では中断される場合があります)。Cloudflare のタイムアウトは 100 s です。省略した場合、デフォルトでブロッキングモードになります。

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

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

レスポンス

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

  • response_modeblocking の場合、 application/jsonCompletionResponse オブジェクトを返します。
  • response_modestreaming の場合、 text/event-streamChunkCompletionEvent オブジェクトのストリームを返します。
event
string

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

task_id
string<uuid>

リクエスト追跡および 生成を停止 API 用のタスク ID です。

id
string<uuid>

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

message_id
string<uuid>

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

mode
string

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

answer
string

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

metadata
object

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

created_at
integer<int64>

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