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
API Key

create

POST
https://api.groundx.ai/api/v1/apikey
POST
/api/v1/apikey
1from groundx import GroundX
2
3client = GroundX(
4    api_key="YOUR_API_KEY_HERE",
5)
6
7client.api_key.create(
8    name="GroundX Production Key",
9)
1{
2  "apiKeys": [
3    {
4      "apiKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
5      "created": "2024-04-20T10:15:30Z",
6      "name": "GroundX Production Key"
7    }
8  ]
9}
Create a new API key.
Was this page helpful?
Previous

update

Next
Built with

Authentication

X-API-Keystring
API Key authentication via header

Request

This endpoint expects an object.
namestringRequired

Response

API key successfully created
apiKeyslist of objects

Errors

400
Bad Request Error