Get file metadata

files.retrieve() -> File

GET/v1/files/{file_id}

Get metadata for a specific file.

ParametersExpand Collapse

file_id: str

The unique identifier of the file.

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'.

Get file metadata

import os
from deeptable import DeepTable

client = DeepTable(
    api_key=os.environ.get("DEEPTABLE_API_KEY"),  # This is the default and can be omitted
)
file = client.files.retrieve(
    "file_01abc2def3ghjkmnpqrs4uvwxy",
)
print(file.id)

{
  "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"
}

Returns Examples

{
  "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"
}