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.

Documentation API Reference SDKs

Documentation API Reference SDKs

Documents
Search
- POSTsearch.content
- POSTsearch.documents
Buckets
Groups
Workflows
Customer
- GETget
API Key
Health
- GETlist
- GETget

update

PUT

https://api.groundx.ai/api/v1/apikey/:apiKey

PUT

/api/v1/apikey/:apiKey

1 from groundx import GroundX
2 
3 client = GroundX(
4     api_key="YOUR_API_KEY_HERE",
5 )
6 
7 client.api_key.update(
8     api_key="apiKey",
9     name="ProjectX-Analytics-Key",
10 )

200Updated

1 {
2   "apiKeys": [
3     {
4       "apiKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
5       "created": "2023-10-03T08:59:39.312Z",
6       "name": "ProjectX-Analytics-Key"
7     }
8   ]
9 }

Rename an API key.

Was this page helpful?

delete

Authentication

X-API-Keystring

API Key authentication via header

Path parameters

apiKeystringRequiredformat: "uuid"

The API key being updated.

Request

This endpoint expects an object.

namestringRequired

Response

API key successfully updated

apiKeyslist of objects