utility

Utility Endpoints

These endpoints provide metadata about the API's status and capabilities.

Health Check

Returns the operational status of the API. A 200 OK response indicates that the service is running.

GET /healthz

Example Response:

{
  "ok": true
}

---

Capabilities

Returns a JSON object describing the features supported by this version of the Agent.

GET /capabilities

Example Response:

{
  "version": "1.0.0",
  "memory": [
    "mentions",
    "tickers"
  ],
  "filters": [
    "limit",
    "since",
    "until",
    "author",
    "ticker",
    "q"
  ],
  "specs": [
    "openapi.v3"
  ]
}

---

OpenAPI Specification

Returns the full OpenAPI 3.0 specification for the API in YAML format. This can be used to generate client libraries or import into API testing tools like Postman.

GET /openapi.yaml