create | Documentation

create a new group, a group being a collection of buckets which can be searched.

X-API-Keystring

API Key authentication via header

This endpoint expects an object.

namestringRequired

The name of the group being created.

bucketNamestringOptional

Specify bucketName to automatically create a bucket, by the name specified, and add it to the created group.

Group successfully created

groupobject

400

Bad Request Error

API Key authentication via header

This endpoint expects an object.

The name of the group being created.

Specify bucketName to automatically create a bucket, by the name specified, and add it to the created group.

Group successfully created

1	{
2	"group": {
3	"groupId": 5001,
4	"buckets": [
5	{
6	"bucketId": 101,
7	"created": "2024-05-20T14:22:10.123Z",
8	"fileCount": 25,
9	"fileSize": "12.4GB",
10	"name": "Research Papers 2024",
11	"updated": "2024-06-01T09:15:45.456Z"
12	}
13	],
14	"created": "2024-05-20T14:22:10.123Z",
15	"fileCount": 25,
16	"fileSize": "12.4GB",
17	"name": "Research Documents",
18	"prompt": "Search within research documents for relevant papers.",
19	"updated": "2024-06-01T09:15:45.456Z"
20	}
21	}

1	{
2	"group": {
3	"groupId": 5001,
4	"buckets": [
5	{
6	"bucketId": 101,
7	"created": "2024-05-20T14:22:10.123Z",
8	"fileCount": 25,
9	"fileSize": "12.4GB",
10	"name": "Research Papers 2024",
11	"updated": "2024-06-01T09:15:45.456Z"
12	}
13	],
14	"created": "2024-05-20T14:22:10.123Z",
15	"fileCount": 25,
16	"fileSize": "12.4GB",
17	"name": "Research Documents",
18	"prompt": "Search within research documents for relevant papers.",
19	"updated": "2024-06-01T09:15:45.456Z"
20	}
21	}