Skip to content
DeepTable
Get started
API Reference
Structured Sheets

Delete structured sheet

structured_sheets.delete(strstructured_sheet_id) -> StructuredSheetDeleteResponse
DELETE/v1/structured-sheets/{structured_sheet_id}

Delete a structured sheet conversion and its associated exports. This action cannot be undone.

ParametersExpand Collapse
structured_sheet_id: str

The unique identifier of the structured sheet conversion.

ReturnsExpand Collapse
class StructuredSheetDeleteResponse: …

Response from deleting a structured sheet.

Following the OpenAI API convention for delete responses.

id: str

The unique identifier of the deleted structured sheet.

deleted: Literal[true]

Whether the structured sheet was successfully deleted.

object: Literal["structured_sheet"]

The object type, which is always 'structured_sheet'.

Delete structured sheet

import os
from deeptable import DeepTable

client = DeepTable(
    api_key=os.environ.get("DEEPTABLE_API_KEY"),  # This is the default and can be omitted
)
structured_sheet = client.structured_sheets.delete(
    "ss_01kfxgjd94fn9stqm42nejb627",
)
print(structured_sheet.id)
{
  "id": "ss_01kfxgjd94fn9stqm42nejb627",
  "deleted": true,
  "object": "structured_sheet"
}
Returns Examples
{
  "id": "ss_01kfxgjd94fn9stqm42nejb627",
  "deleted": true,
  "object": "structured_sheet"
}