Skip to content

API reference

Health and OpenAPI

Check whether the API and its database are up, and download the OpenAPI 3.1 document for every public endpoint.

Health check

GET/api/v1/health
No key

Reports whether the API is up and can reach its database. No key needed; it does not count against any limit.

Request

No parameters and no body.

Response

200 Healthy (200) or degraded (503, database unreachable). Both use this shape.

FieldDescription
statusstring"degraded" when the database check failed.one of "healthy", "degraded"
timestampstringServer time.date-time
versionstringServer API version.
environmentstringServer environment, "production" on enton.ai.
servicesobjectPer-service status.
services.databasestringDatabase reachability.one of "operational", "down"
services.apistringAlways "operational" when this responds.one of "operational"
endpointsobjectPaths of the main endpoints.
documentationstringLink to these docs.uri
developerstringLink to the developer portal.uri
Example response
{
  "status": "healthy",
  "timestamp": "2026-10-23T14:02:11.093Z",
  "version": "v1.0.0",
  "environment": "production",
  "services": {
    "database": "operational",
    "api": "operational"
  },
  "endpoints": {
    "ai": "/api/v1/ai/query",
    "trading": "/api/v1/trading/cards",
    "execute": "/api/v1/trading/execute",
    "discovery": "/api/v1/discover",
    "oauth": "/api/v1/oauth/[provider]"
  },
  "documentation": "https://enton.ai/docs",
  "developer": "https://enton.ai/developer"
}

Errors

StatusWhenerror
503The database is unreachable (status "degraded"), or the check itself failed (status "error", with message and error fields).Varies

This endpoint needs no key and is not rate limited.

Examples

curl "https://enton.ai/api/v1/health"

OpenAPI document

GET/api/v1/openapi.json
No key

This API described as OpenAPI 3.1, built from the same source as these pages. Import it into Postman, Insomnia or a client generator. No key needed.

Request

No parameters and no body.

Response

200 An OpenAPI 3.1 document.

FieldDescription
openapistring"3.1.0".
infoobjectTitle and version.
serversarray of objectBase URL.
pathsobjectEvery public endpoint.
componentsobjectShared schemas, responses and the bearer scheme.
Example response
{
  "openapi": "3.1.0",
  "info": {
    "title": "ENTON API",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://enton.ai/api/v1"
    }
  ],
  "paths": {},
  "components": {}
}

Errors

This endpoint needs no key and is not rate limited.

Examples

curl "https://enton.ai/api/v1/openapi.json"