生成を停止

テキスト生成メッセージ生成タスクを停止します。streaming モードでのみサポートされています。

POST /completion-messages/{task_id}/stop

Error

A valid request URL is required to generate request examples

200

{
  "result": "success"
}

承認

Authorization · string · header · 必須

API Key 認証です。すべての API リクエストにおいて、Authorization HTTP ヘッダーに Bearer プレフィックスを付けた API Key を含めてください。例：Authorization: Bearer {API_KEY}。API Key はサーバーサイドに保存し、クライアントサイドで共有・保存しないことを強く推奨します。API Key の漏洩は深刻な結果につながる可能性があります。

パスパラメータ

task_id · string · 必須

タスク ID です。完了メッセージを送信 API のストリーミングチャンクレスポンスから取得できます。

ボディ

application/json

user · string · 必須

ユーザー識別子。メッセージ送信インターフェースで渡された user と一致する必要があります。

レスポンス

200

application/json

操作が成功しました。

result · string

結果ステータス。