Upload a file

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

POST/v1/files

Upload an Excel spreadsheet file for later processing.

Supported formats:

Excel (.xlsx)

Maximum file size: 100 MB

ParametersExpand Collapse

body: FileUploadParams { file }

file: Uploadable

The spreadsheet file to upload

formatbinary

ReturnsExpand 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

size: number

The size of the file in bytes.

minimum0

object?: "file"

The object type, which is always 'file'.

Upload a file

import DeepTable from '@deeptable/deeptable';

const client = new DeepTable({
  apiKey: process.env['DEEPTABLE_API_KEY'], // This is the default and can be omitted
});

const file = await client.files.upload({ file: fs.createReadStream('path/to/file') });

console.log(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"
}