Create Fileset

POST

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

POST

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

$ curl -X POST https://host.com/apis/files/v2/workspaces/workspace/filesets \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "training-data-v1"
> }'

1 {
2   "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
3   "name": "training-data-v1",
4   "workspace": "research-team-alpha",
5   "description": "Initial training dataset for image classification model",
6   "purpose": "dataset",
7   "storage": {
8     "read_chunk_size": 1048576,
9     "type": "local",
10     "path": "/mnt/data/training-data-v1",
11     "write_buffer_size": 16777216
12   },
13   "metadata": {
14     "dataset": {
15       "schema": {},
16       "schema_defs": {},
17       "schemas_by_path": {}
18     },
19     "model": {
20       "tool_calling": {
21         "chat_template": "Hello, how can I assist you today?",
22         "tool_call_parser": "openai",
23         "tool_call_plugin": "research-team-alpha/custom-tool-plugin",
24         "auto_tool_choice": true
25       }
26     }
27   },
28   "custom_fields": {},
29   "project": "image-classification",
30   "created_at": "2024-06-01T10:15:30Z",
31   "updated_at": "2024-06-01T10:15:30Z"
32 }

Create a new fileset. If no storage configuration is provided, the default storage backend will be used.

Path parameters

workspacestringRequired

Request

This endpoint expects an object.

namestringRequiredformat: "^[\w\-.]+$"<=255 characters

The name of the fileset. Allowed characters: letters (a-z, A-Z), digits (0-9), underscores, hyphens, and dots.

descriptionstringOptional<=255 characters

The description of the fileset.

projectstringOptional

The name of the project associated with this fileset.

storageobjectOptional

The storage configuration for the fileset. If not provided, uses default storage.

purposeenumOptionalDefaults to generic

The purpose of the fileset.

metadataobjectOptional

Purpose-specific metadata. Use the purpose as the key (e.g., {dataset: {…}}).

custom_fieldsmap from strings to anyOptional

Custom fields for the fileset.

cachebooleanOptionalDefaults to false

Cache all files after creation. Only applies to external storage.

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