API reference

System

3 endpoints in this group.

Plan and this month's usage

GET/api/v1/usage

Scope
read
SDK method
getUsage · get_usage
MCP tool
getUsageread-only

Example request

curl -X GET "https://hiboty.com/api/v1/usage" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Example response (200)

JSON
{
  "data": {
    "plan": "string",
    "messages": {
      "used": 1,
      "limit": 1,
      "plan_limit": 1,
      "extra_credits": 1
    },
    "ai_replies": {
      "used": 1,
      "limit": 1
    },
    "storage": {
      "used_bytes": 1,
      "limit_bytes": 1
    }
  }
}

Possible errors

  • 400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
  • 401The API key is missing, invalid or revoked (unauthorized).
  • 403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
  • 429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.

This OpenAPI document

GET/api/v1/openapi.json

Scope
No authentication
SDK method
getOpenApi · get_open_api
MCP tool
No MCP tool

Example request

curl -X GET "https://hiboty.com/api/v1/openapi.json"

Example response (200)

JSON
{}

Health check (no authentication required)

GET/api/health

Scope
No authentication
SDK method
health · health
MCP tool
No MCP tool

Parameters

NameTypeRequiredDescription
cronqueryenumnoWhen set to 1, also returns 503 if background jobs have stopped1

Example request

curl -X GET "https://hiboty.com/api/health"

Example response (200)

JSON
{
  "status": "ok",
  "db": "ok",
  "cron": "ok",
  "cron_age_s": 1,
  "latency_ms": 1,
  "time": "2026-11-06T09:00:00.000Z"
}

Possible errors

  • 503Background jobs have stopped or the service is temporarily unavailable.