Skip to content
Get started

Get file metadata

$ deeptable files retrieve
GET/v1/files/{file_id}

Get metadata for a specific file.

ParametersExpand Collapse
--file-id: string

The unique identifier of the file.

ReturnsExpand Collapse
file: object { 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.

created_at: string

The timestamp when the file was uploaded.

file_name: string

The original filename of the uploaded file.

object: "file"

The object type, which is always 'file'.

"file"
size: number

The size of the file in bytes.

Get file metadata

deeptable files retrieve \
  --api-key 'My API Key' \
  --file-id file_01kfxgjd94fn9stqm414vjb0s8
{
  "id": "file_01kfxgjd94fn9stqm414vjb0s8",
  "content_type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
  "created_at": "2024-01-15T10:30:00Z",
  "file_name": "financial_report.xlsx",
  "object": "file",
  "size": 1048576
}
Returns Examples
{
  "id": "file_01kfxgjd94fn9stqm414vjb0s8",
  "content_type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
  "created_at": "2024-01-15T10:30:00Z",
  "file_name": "financial_report.xlsx",
  "object": "file",
  "size": 1048576
}