API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Files

Upload and manage spreadsheet files. Files must be Excel (.xlsx) format.

List files

client.files.list(FileListParams { after, limit } query?, RequestOptionsoptions?): CursorIDPage<File { id, content_type, created_at, 3 more } >

GET/v1/files

Upload a file

client.files.upload(FileUploadParams { file } body, RequestOptionsoptions?): File { id, content_type, created_at, 3 more }

POST/v1/files

Delete a file

client.files.delete(stringfileID, RequestOptionsoptions?): FileDeleteResponse { id, deleted, object }

DELETE/v1/files/{file_id}

Get file metadata

client.files.retrieve(stringfileID, RequestOptionsoptions?): File { id, content_type, created_at, 3 more }

GET/v1/files/{file_id}

Download file

client.files.download(stringfileID, RequestOptionsoptions?): Response

GET/v1/files/{file_id}/content

ModelsExpand Collapse

File { id, content_type, created_at, 3 more }

Response representing an uploaded file.

This is returned from POST (upload), GET (retrieve), and list endpoints.

id: string

The unique identifier for this file.

content_type: string

The MIME type of the file.

maxLength255

created_at: string

The timestamp when the file was uploaded.

formatdate-time

file_name: string

The original filename of the uploaded file.

maxLength255

object: "file"

The object type, which is always 'file'.

size: number

The size of the file in bytes.

minimum0