Get Fileset by Workspace and Name

GET

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

GET

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

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

1 {
2   "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
3   "name": "customer_data_2024",
4   "workspace": "marketing_team",
5   "description": "Fileset containing customer data for Q1 2024 marketing analysis",
6   "purpose": "dataset",
7   "storage": {
8     "read_chunk_size": 1048576,
9     "type": "local",
10     "path": "/mnt/data/marketing/customer_data_2024",
11     "write_buffer_size": 16777216
12   },
13   "metadata": {
14     "dataset": {
15       "schema": {
16         "type": "object",
17         "properties": {
18           "customer_id": {
19             "type": "string"
20           },
21           "email": {
22             "type": "string",
23             "format": "email"
24           },
25           "signup_date": {
26             "type": "string",
27             "format": "date"
28           },
29           "purchase_amount": {
30             "type": "number"
31           }
32         },
33         "required": [
34           "customer_id",
35           "email",
36           "signup_date"
37         ]
38       },
39       "schema_defs": {},
40       "schemas_by_path": {
41         "2024/Q1/customers.csv": {
42           "type": "object",
43           "properties": {
44             "customer_id": {
45               "type": "string"
46             },
47             "email": {
48               "type": "string",
49               "format": "email"
50             },
51             "signup_date": {
52               "type": "string",
53               "format": "date"
54             },
55             "purchase_amount": {
56               "type": "number"
57             }
58           },
59           "required": [
60             "customer_id",
61             "email",
62             "signup_date"
63           ]
64         }
65       }
66     },
67     "model": {
68       "tool_calling": {
69         "chat_template": "Hello {{user}}, how can I assist you with the customer data?",
70         "tool_call_parser": "openai",
71         "tool_call_plugin": "analytics_team/customer_data_plugin",
72         "auto_tool_choice": false
73       }
74     }
75   },
76   "custom_fields": {
77     "data_owner": "jane.doe@example.com",
78     "retention_policy": "2 years"
79   },
80   "project": "Q1 Marketing Campaign",
81   "created_at": "2024-04-01T09:15:00Z",
82   "updated_at": "2024-04-15T16:45:00Z"
83 }

Get Fileset by Workspace and Name. Returns the details of a specific fileset identified by its workspace and name.

Path parameters

workspacestringRequired

namestringRequired

Response

Successful Response

idstring

namestring

workspacestring

descriptionstring

purposeenum

storageobject

metadataobject

Tagged metadata container - the key indicates the type.

Example: metadata = FilesetMetadata( dataset=DatasetMetadataContent( schema={“columns”: [“id”, “name”]}, ) )

custom_fieldsmap from strings to any

projectstring

created_atstring

updated_atstring

Errors

422

Unprocessable Entity Error