Skip to main content
GET
/
api
/
dataframer
/
datasets
JavaScript
import Dataframer from 'dataframer';

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

const datasets = await client.dataframer.datasets.list();

console.log(datasets);
[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Customer Reviews Dataset",
    "description": "Product reviews for analysis",
    "dataset_type": "SINGLE_FILE",
    "dataset_type_display": "Single File",
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-01-15T10:30:00Z",
    "created_by_name": "[email protected]",
    "folder_count": 0,
    "file_count": 1,
    "short_sample_compatibility": {
      "is_short_samples_compatible": true,
      "is_long_samples_compatible": false,
      "reason": null
    }
  }
]

Authorizations

​
Authorization
string
header
required

API Key authentication. Format: "Bearer YOUR_API_KEY"

Response

List of datasets

​
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
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
created_by_name
string
Minimum string length: 1
​
folder_count
integer
​
file_count
integer
​
short_sample_compatibility
Short sample compatibility · object