Skip to main content
POST
/
api
/
dataframer
/
datasets
/
create-from-zip
JavaScript
import Dataframer from 'dataframer';

const client = new Dataframer({
  apiKey: 'My API Key',
});

const response = await client.dataframer.datasets.createFromZip({
  name: 'name',
  zip_file: fs.createReadStream('path/to/file'),
});

console.log(response.id);
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "My Dataset",
  "description": "Uploaded from ZIP",
  "dataset_type": "MULTI_FOLDER",
  "dataset_type_display": "Multi Folder",
  "file_count": 10,
  "folder_count": 2,
  "created_at": "2025-01-15T10:30:00Z",
  "auto_detected_type": "MULTI_FOLDER",
  "message": "Dataset created with 10 file(s) (auto-detected as MULTI_FOLDER)"
}

Authorizations

​
Authorization
string
header
required

API Key authentication. Format: "Bearer YOUR_API_KEY"

Body

multipart/form-data
​
name
string
required

Dataset name (unique within company)

​
zip_file
file
required

ZIP file containing dataset files

​
description
string

Optional dataset description

Response

Dataset created successfully with auto-detected type

​
name
string
required
Minimum string length: 1
​
dataset_type
enum<string>
required
Available options:
SINGLE_FILE,
MULTI_FILE,
MULTI_FOLDER
​
id
string<uuid>
​
description
string | null
​
dataset_type_display
string
Minimum string length: 1
​
config_json
Config json · object
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
created_by
integer
​
created_by_name
string
Minimum string length: 1
​
company
string<uuid>
​
company_name
string
Minimum string length: 1
​
folders
object[]
​
folder_count
integer
​
file_count
integer
​
short_sample_compatibility
Short sample compatibility · object