Skip to content
Dashboard

Delete a response

responses.delete(strid) -> ResponseDeleteResponse
DELETE/v1/responses/{id}

Permanently delete a response and all its output items.

ParametersExpand Collapse
id: str
ReturnsExpand Collapse
class ResponseDeleteResponse:
id: Optional[str]
deleted: Optional[bool]
object: Optional[str]

Delete a response

import os
from tzafon import Lightcone

client = Lightcone(
    api_key=os.environ.get("TZAFON_API_KEY"),  # This is the default and can be omitted
)
response = client.responses.delete(
    "id",
)
print(response.id)
{
  "id": "id",
  "deleted": true,
  "object": "object"
}
Returns Examples
{
  "id": "id",
  "deleted": true,
  "object": "object"
}