List Filesets

GET

https://host.com/apis/files/v2/workspaces/:workspace/filesets

GET

/apis/files/v2/workspaces/:workspace/filesets

$ curl https://host.com/apis/files/v2/workspaces/workspace/filesets \
>      -H "Content-Type: application/json"

1 {
2   "data": [
3     {
4       "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
5       "name": "Customer Transactions Dataset",
6       "workspace": "finance_team",
7       "description": "Monthly customer transaction records for analysis",
8       "purpose": "dataset",
9       "storage": {
10         "read_chunk_size": 1048576,
11         "type": "local",
12         "path": "/mnt/data/finance/transactions/2024-05",
13         "write_buffer_size": 16777216
14       },
15       "metadata": {
16         "dataset": {
17           "schema": {
18             "type": "object",
19             "properties": {
20               "transaction_id": {
21                 "type": "string"
22               },
23               "customer_id": {
24                 "type": "string"
25               },
26               "amount": {
27                 "type": "number"
28               },
29               "date": {
30                 "type": "string",
31                 "format": "date"
32               }
33             },
34             "required": [
35               "transaction_id",
36               "customer_id",
37               "amount",
38               "date"
39             ]
40           },
41           "schema_defs": {
42             "currency": {
43               "type": "string",
44               "enum": [
45                 "USD",
46                 "EUR",
47                 "GBP"
48               ]
49             }
50           },
51           "schemas_by_path": {
52             "special_transactions.json": {
53               "type": "object",
54               "properties": {
55                 "transaction_id": {
56                   "type": "string"
57                 },
58                 "special_flag": {
59                   "type": "boolean"
60                 }
61               },
62               "required": [
63                 "transaction_id",
64                 "special_flag"
65               ]
66             }
67           }
68         },
69         "model": {
70           "tool_calling": {
71             "chat_template": "Hello, how can I assist you with the model?",
72             "tool_call_parser": "openai",
73             "tool_call_plugin": "finance_team/custom_tool_plugin",
74             "auto_tool_choice": false
75           }
76         }
77       },
78       "custom_fields": {
79         "department": "Finance",
80         "confidential": "true"
81       },
82       "project": "Q2 Financial Analysis",
83       "created_at": "2024-05-01T08:30:00Z",
84       "updated_at": "2024-05-15T12:45:00Z"
85     }
86   ],
87   "pagination": {
88     "page": 1,
89     "page_size": 10,
90     "current_page_size": 1,
91     "total_pages": 1,
92     "total_results": 1
93   },
94   "sort": "-created_at",
95   "filter": {}
96 }

List Filesets endpoint with filtering and pagination.

Supports filtering by name, description, purpose, storage_type, created_at, and updated_at via query parameters. Returns paginated results with sorting options.

Path parameters

workspacestringRequired

Query parameters

pageintegerOptional>=1Defaults to 1

Page number.

page_sizeintegerOptional1-100Defaults to 10

Page size.

sortenumOptionalDefaults to -created_at

The field to sort by. To sort in decreasing order, use - in front of the field name.

Allowed values:

filterobjectOptional

Filter filesets by name, description, purpose, storage_type, created_at, and updated_at.

Response

Successful Response

datalist of objects

paginationobject

Pagination information.

sortstring

The field on which the results are sorted.

filtermap from strings to any

Filtering information.

Errors

422

Unprocessable Entity Error