List files

files.list() -> SyncCursorIDPage[File]

GET/v1/files

List all files uploaded by the current user.

ParametersExpand Collapse

after: Optional[str]

Unique identifier for a file.

limit: Optional[int]

Maximum number of files to return.

maximum100

minimum1

ReturnsExpand Collapse

class File: …

Response representing an uploaded file.

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

id: str

The unique identifier for this file.

content_type: str

The MIME type of the file.

maxLength255

created_at: datetime

The timestamp when the file was uploaded.

formatdate-time

file_name: str

The original filename of the uploaded file.

maxLength255

size: int

The size of the file in bytes.

minimum0

object: Optional[Literal["file"]]

The object type, which is always 'file'.

List files

import os
from deeptable import DeepTable

client = DeepTable(
    api_key=os.environ.get("DEEPTABLE_API_KEY"),  # This is the default and can be omitted
)
page = client.files.list()
page = page.data[0]
print(page.id)

{
  "data": [
    {
      "id": "file_01abc2def3ghjkmnpqrs4uvwxy",
      "content_type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
      "created_at": "2024-01-15T10:30:00Z",
      "file_name": "financial_report.xlsx",
      "size": 1048576,
      "object": "file"
    }
  ],
  "has_more": false,
  "first_id": "file_01abc2def3ghjkmnpqrs4uvwxy",
  "last_id": "file_01abc2def3ghjkmnpqrs4uvwxy",
  "object": "list"
}

Returns Examples

{
  "data": [
    {
      "id": "file_01abc2def3ghjkmnpqrs4uvwxy",
      "content_type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
      "created_at": "2024-01-15T10:30:00Z",
      "file_name": "financial_report.xlsx",
      "size": 1048576,
      "object": "file"
    }
  ],
  "has_more": false,
  "first_id": "file_01abc2def3ghjkmnpqrs4uvwxy",
  "last_id": "file_01abc2def3ghjkmnpqrs4uvwxy",
  "object": "list"
}