Skip to content
Get started

Delete structured sheet

client.StructuredSheets.Delete(ctx, structuredSheetID) (*StructuredSheetDeleteResponse, error)
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
type StructuredSheetDeleteResponse struct{…}

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 bool

Whether the structured sheet was successfully deleted.

Object StructuredSheet

The object type, which is always 'structured_sheet'.

Delete structured sheet

package main

import (
  "context"
  "fmt"

  "github.com/deeptable-com/deeptable-go"
  "github.com/deeptable-com/deeptable-go/option"
)

func main() {
  client := deeptable.NewClient(
    option.WithAPIKey("My API Key"),
  )
  structuredSheet, err := client.StructuredSheets.Delete(context.TODO(), "ss_01kfxgjd94fn9stqm42nejb627")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", structuredSheet.ID)
}
{
  "id": "ss_01kfxgjd94fn9stqm42nejb627",
  "deleted": true,
  "object": "structured_sheet"
}
Returns Examples
{
  "id": "ss_01kfxgjd94fn9stqm42nejb627",
  "deleted": true,
  "object": "structured_sheet"
}