For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sign Up
DocumentationAPI ReferenceSDKs
DocumentationAPI ReferenceSDKs
  • Documents
    • Ingest Documents
    • Ingest Directories
    • POSTcrawl_website
    • GETget_processing_status_by_id
    • GETlist
    • GETget
    • GETlookup
    • DELdelete (singular)
    • DELdelete (multiple)
    • GETget_processes
    • POSTcopy
    • PUTupdate
    • DELcancel_process
    • GETget_extract
    • GETget_xray
  • Search
    • POSTsearch.content
    • POSTsearch.documents
  • Buckets
    • GETlist
    • GETget
    • POSTcreate
    • PUTupdate
    • DELdelete
  • Groups
    • GETlist
    • GETget
    • POSTcreate
    • PUTupdate
    • DELdelete
    • POSTaddBucket
    • DELremoveBucket
  • Workflows
    • GETlist
    • POSTcreate
    • GETget_account
    • POSTadd_to_account
    • DELremove_from_account
    • POSTadd_to_id
    • DELremove_from_id
    • GETget
    • PUTupdate
    • DELdelete
  • Customer
    • GETget
  • API Key
    • GETlist
    • POSTcreate
    • PUTupdate
    • DELdelete
  • Health
    • GETlist
    • GETget
Sign Up
LogoLogo
Groups

update

PUT
https://api.groundx.ai/api/v1/group/:groupId
PUT
/api/v1/group/:groupId
1from groundx import GroundX
2
3client = GroundX(
4 api_key="YOUR_API_KEY_HERE",
5)
6
7client.groups.update(
8 group_id=1,
9 new_name="Marketing Team",
10)
1{
2 "group": {
3 "groupId": 1,
4 "buckets": [
5 {
6 "bucketId": 42,
7 "created": "2024-05-10T09:15:30Z",
8 "fileCount": 15,
9 "fileSize": "12.4GB",
10 "name": "Q2 Campaign Assets",
11 "updated": "2024-06-01T14:22:10Z"
12 }
13 ],
14 "created": "2023-11-20T08:00:00Z",
15 "fileCount": 150,
16 "fileSize": "120.7GB",
17 "name": "Marketing Team",
18 "prompt": "Discuss marketing strategies and campaign progress.",
19 "updated": "2024-06-01T14:22:10Z"
20 }
21}
Rename a group
Was this page helpful?
Previous

delete

Next
Built with

Authentication

X-API-Keystring
API Key authentication via header

Path parameters

groupIdintegerRequired
The groupId of the group to update.

Request

This endpoint expects an object.
newNamestringRequired
The new name of the group being renamed.

Response

Successful update of group
groupobject

Errors

400
Bad Request Error
401
Unauthorized Error