Skip to main content
post/completion-messages
Request example
Response
post/completion-messages

Authorization

Authorizationstringheaderrequired#

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

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

Body

application/json
filesobject[]#
リクエストに添付するファイルです。ローカルファイルの場合は、まず ファイルをアップロード でアップロードし、返された id を upload_file_id として transfer_method: local_file で参照します。
inputsobjectrequired#
アプリの入力変数の値を、変数名をキーとして指定します。期待される名前と型は、アプリケーションのパラメータ情報を取得 の user_input_form フィールドで確認できます。
querystring#
処理するテキストです。レガシーフィールドで、新しいアプリではこの値を inputs の中で渡します。

Default: ""

response_modeenum<string>#
レスポンスの返却モード。streaming(推奨)は SSE を使用します。blocking は完了後に返却します(長時間の処理では中断される場合があります)。Cloudflare のタイムアウトは 100 s です。省略した場合、デフォルトでブロッキングモードになります。
Options:streamingblocking
userstringrequired#
エンドユーザーの識別子。アプリ側で定義し、アプリ内で一意にします。メッセージとファイルは、同じ user を持つリクエストにのみ表示されます。エンドユーザーの識別 を参照してください。

Responses

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

  • response_mode が blocking の場合、 application/json で CompletionResponse オブジェクトを返します。
  • response_mode が streaming の場合、 text/event-stream で ChunkCompletionEvent オブジェクトのストリームを返します。
answerstring#
完全なレスポンスコンテンツ。
created_atinteger#
メッセージ作成タイムスタンプ(Unix エポック秒)。
eventstring#
イベントタイプ。message に固定されています。
idstring#
このレスポンスイベントの一意 ID です。
message_idstring#
一意のメッセージ ID です。フィードバックや推奨質問のエンドポイントを呼び出す際に message_id パラメータとして使用します。
metadataobject#
使用量と検索リソースを含むメタデータ。
modestring#
アプリモード、completion 固定です。
task_idstring#
リクエスト追跡および 生成を停止 API 用のタスク ID です。