Skip to main content
GET
/
status
GET /status
curl --request GET \
  --url https://api.example.com/status \
  --header 'Authorization: Bearer <token>'

​
GET /status

Check the health and status of the AG-UI server.

​
Endpoint

GET /status

​
Description

Returns the current status of the AG-UI server, useful for health checks and monitoring.

​
Request

No request body or parameters required.

​
Response

​
Success Response (200 OK)

{
  "status": "ok",
  "agent": "Assistant",
  "protocol": "ag-ui",
  "version": "1.0.0"
}

​
Response Fields

FieldTypeDescription
statusstringServer status
agentstringAgent name
protocolstringProtocol type
versionstringServer version

​
Example

​
cURL

curl -X GET http://localhost:8000/status

​
Python

import requests

response = requests.get("http://localhost:8000/status")
status = response.json()
print(f"Status: {status['status']}")

​
See Also