System API

This API provides endpoints to retrieve and expose Active Docker Image Version for observability and support of systems.

Endpoints

Authentication

All endpoints require authentication using one of the following:

• Authorization: Bearer $GEAI_APITOKEN
• Authorization: Bearer $OAuth_accesstoken

For $OAuth_accesstoken, you must also include the header: ProjectId: $GEAI_PROJECT_ID.

GET /system/status

Retrieves the current health status of the system along with the active Docker image version and a timestamp.

Request

• Method: GET
• Path: $BASE_URL/v1/system/status
• Request Body: Empty

Response

  {
    "running": boolean,                // Indicates if the system is currently running
    "timestamp": "string",          // Timestamp of the status check
    "version": "string"             // Version of the running Docker image
  }
  

Sample cURL

  curl -X GET "$BASE_URL/v1/system/status" \
    -H "Authorization: Bearer $GEAI_APITOKEN"
  

GET /system/version

Retrieves the version of the currently active Docker image.

Request

• Method: GET
• Path: $BASE_URL/v1/system/version
• Request Body: Empty

Response

  {
    "image": "string"             // Version of the running Docker image.
  }
  

Sample cURL

 curl -X GET "$BASE_URL/v1/system/version" \
    -H "Authorization: Bearer $GEAI_APITOKEN"
  

Availability

Since version 2025-10.