テキスト

Delete Response

保存されたレスポンスを削除します。生成のキャンセルは行われません。

DELETE
/v1/responses/{id}

概要

IDを指定して、保存されたレスポンスを削除します。削除後、そのIDは取得できなくなり、previous_response_id として使用することもできなくなります。

これは削除であり、キャンセルではありません。実行中のレスポンスを停止させることはできません。削除できるのは、自身のカウントで作成されたレスポンスのみです。不明なID、別のアカウントのID、すでに削除済みのIDを指定した場合は、すべて 404 が返されます。

例

リクエスト

cURL
curl -X DELETE "https://api.tokenlab.sh/v1/responses/resp_abc123" \
  -H "Authorization: Bearer sk-your-api-key"

レスポンス例

レスポンス

200 OK
{
  "id": "resp_abc123",
  "object": "response.deleted",
  "deleted": true
}
deletedboolean
レスポンスが削除された場合に true となります。このフィールドを確認してください。object の値はモデルによって異なる場合があります。

エラー

ステータスコード意味
404response_not_foundIDが不明、別のアカウントに属している、またはすでに削除されています。
502upstream_delete_failedTokenLabは、レスポンスを生成したサービス側で削除を実行できませんでした。レスポンスは保存されたままです。後ほど再試行してください。
503upstream_delete_recovery_pending削除処理が調整中です。すぐに再送しないでください。
503response_state_unavailableレスポンスの状態が一時的に利用できません。後ほど再試行してください。

認証

BearerAuth
AuthorizationBearer <token>

APIキー認証。Dashboard > API > API KeysでAPIキーを作成または管理します。

場所: header

パスパラメータ

id*string

POST /v1/responses によって返されたレスポンスID。

レスポンス

application/json

application/json

application/json

application/json