テキスト
Delete Response
保存されたレスポンスを削除します。生成のキャンセルは行われません。
概要
IDを指定して、保存されたレスポンスを削除します。削除後、そのIDは取得できなくなり、previous_response_id として使用することもできなくなります。
これは削除であり、キャンセルではありません。実行中のレスポンスを停止させることはできません。削除できるのは、自身のカウントで作成されたレスポンスのみです。不明なID、別のアカウントのID、すでに削除済みのIDを指定した場合は、すべて 404 が返されます。
リクエスト
curl -X DELETE "https://api.tokenlab.sh/v1/responses/resp_abc123" \
-H "Authorization: Bearer sk-your-api-key"レスポンス例
レスポンス
{
"id": "resp_abc123",
"object": "response.deleted",
"deleted": true
}deletedboolean
レスポンスが削除された場合に
true となります。このフィールドを確認してください。object の値はモデルによって異なる場合があります。エラー
| ステータス | コード | 意味 |
|---|---|---|
404 | response_not_found | IDが不明、別のアカウントに属している、またはすでに削除されています。 |
502 | upstream_delete_failed | TokenLabは、レスポンスを生成したサービス側で削除を実行できませんでした。レスポンスは保存されたままです。後ほど再試行してください。 |
503 | upstream_delete_recovery_pending | 削除処理が調整中です。すぐに再送しないでください。 |
503 | response_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