Skip to content
Get started

Delete structured sheet

$ deeptable structured-sheets delete
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: string

The unique identifier of the structured sheet conversion.

ReturnsExpand Collapse
StructuredSheetDeleteResponse: object { id, deleted, object }

Response from deleting a structured sheet.

Following the OpenAI API convention for delete responses.

id: string

The unique identifier of the deleted structured sheet.

deleted: true

Whether the structured sheet was successfully deleted.

true
object: "structured_sheet"

The object type, which is always 'structured_sheet'.

"structured_sheet"

Delete structured sheet

deeptable structured-sheets delete \
  --api-key 'My API Key' \
  --structured-sheet-id ss_01kfxgjd94fn9stqm42nejb627
{
  "id": "ss_01kfxgjd94fn9stqm42nejb627",
  "deleted": true,
  "object": "structured_sheet"
}
Returns Examples
{
  "id": "ss_01kfxgjd94fn9stqm42nejb627",
  "deleted": true,
  "object": "structured_sheet"
}