For AI agents: the documentation index is at /llms.txt, and this page is available as Markdown at /api/institutional/get-service-health-cefi.md.

Get service health

GET
/v1/cefi/health

Returns the current readiness status for the REST API Gateway. The response includes a human-readable status indicator, the service name, and the timestamp when the status was generated.

Response Body

Service is ready to handle requests.

application/json
  1. response

Status information for the REST API Gateway.

status*string

Overall readiness indicator for the API.

Value in"healthy""degraded"
timestamp*string

UTC timestamp the status was generated formatted as YYYY-MM-DD HH:MM:SS.

service*string

Name of the service reporting health.

Example Request
curl -X GET 'https://api.truex.co/v1/cefi/health'
Example Response
{  "status": "healthy",  "timestamp": "2025-01-15 14:30:00",  "service": "rag"}