logo
Groups

create

post
https://api.groundx.ai/api/v1/group

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

Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.

Execute an API Request

Request Body
namestringrequired

The name of the group being created.

bucketNamestring

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

Authorization
Request
Installation
$
npm install groundx-typescript-sdk
1
Loading...

Response fields

object
groupobject
1
{
2
"group": {
3
"buckets": [
4
{
5
"bucketId": 0,
6
"created": "2023-10-03T08:59:39.312Z",
7
"fileCount": 0,
8
"fileSize": "3.1GB",
9
"name": "string",
10
"updated": "2023-10-03T08:59:39.312Z"
11
}
12
],
13
"created": "2023-10-03T08:59:39.312Z",
14
"fileCount": 0,
15
"fileSize": "3.1GB",
16
"groupId": 0,
17
"name": "string",
18
"updated": "2023-10-03T08:59:39.312Z"
19
}
20
}