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
Health

get

GET
https://api.groundx.ai/api/v1/health/:service
GET
/api/v1/health/:service
1from groundx import GroundX
2
3client = GroundX(
4    api_key="YOUR_API_KEY_HERE",
5)
6
7client.health.get(
8    service="search",
9)
1{
2  "health": {
3    "services": [
4      {
5        "lastUpdate": "2023-10-03T08:59:39.312Z",
6        "service": "search",
7        "status": "healthy"
8      }
9    ]
10  }
11}
Look up the current health status of a specific service. Statuses update every 5 minutes.
Was this page helpful?
Previous
Built with

Authentication

X-API-Keystring
API Key authentication via header

Path parameters

servicestringRequired
The name of the service to look up.

Response

Look up success
healthobject

Errors

400
Bad Request Error