Skip to main content
post/chat-messages/{task_id}/stop
Request example
Response
post/chat-messages/{task_id}/stop

Authorization

Authorizationstringheaderrequired#

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

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

Path parameters

task_idstringrequired#
タスク ID です。チャットメッセージを送信 のストリーミングイベントから取得します。

Body

application/json
userstringrequired#
エンドユーザーの識別子。アプリ側で定義し、アプリ内で一意にします。元のメッセージ送信時に渡した user と一致する必要があります。一致しない場合、停止は行われず、成功が返されます。エンドユーザーの識別 を参照してください。

Responses

application/json
操作が成功しました。
resultstring#
操作結果。常に success です。