API Reference

Structured Sheets

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Delete structured sheet

client.structuredSheets.delete(stringstructuredSheetID, RequestOptionsoptions?): StructuredSheetDeleteResponse { id, deleted, object }

DELETE/v1/structured-sheets/{structured_sheet_id}

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

ParametersExpand Collapse

structuredSheetID: string

The unique identifier of the structured sheet conversion.

ReturnsExpand Collapse

StructuredSheetDeleteResponse { 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.

object: "structured_sheet"

The object type, which is always 'structured_sheet'.

Delete structured sheet

TypeScript

HTTP

TypeScript

Python

Go

CLI Tool

import DeepTable from '@deeptable/deeptable';

const client = new DeepTable({
  apiKey: process.env['DEEPTABLE_API_KEY'], // This is the default and can be omitted
});

const structuredSheet = await client.structuredSheets.delete('ss_01kfxgjd94fn9stqm42nejb627');

console.log(structuredSheet.id);

200 example

{
  "id": "ss_01kfxgjd94fn9stqm42nejb627",
  "deleted": true,
  "object": "structured_sheet"
}

Returns Examples

200 example

{
  "id": "ss_01kfxgjd94fn9stqm42nejb627",
  "deleted": true,
  "object": "structured_sheet"
}