Skip to main content
GET
/
api
/
dataframer
/
datasets
/
{dataset_id}
/
files
JavaScript
import Dataframer from 'dataframer';

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

const files = await client.dataframer.datasets.listFiles('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(files);
[
  {
    "file_name": "<string>",
    "file_type": "JSON",
    "storage_uri": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "file_type_display": "<string>",
    "bytes_size": 0,
    "sha256": "<string>",
    "folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "datasets_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
Authorization
string
header
required

API Key authentication. Format: "Bearer YOUR_API_KEY"

Path Parameters

​
dataset_id
string
required

Response

List of files

​
file_name
string
required
Minimum string length: 1
​
file_type
enum<string>
required
Available options:
JSON,
JSONL,
CSV,
MD,
TXT,
PDF
​
storage_uri
string
required
Minimum string length: 1
​
id
string<uuid>
​
file_type_display
string
Minimum string length: 1
​
bytes_size
integer | null
Required range: -9223372036854776000 <= x <= 9223372036854776000
​
sha256
string | null
​
folder_id
string<uuid> | null
​
datasets_id
string<uuid>
​
created_at
string<date-time>