API reference

API keys

5 endpoints in this group.

Lists API keys

GET/api/v1/api-keys

The key and its hash are never returned, only its prefix. New keys are created only in the dashboard: a key minting wider keys, or keys that survive its own revocation, would be a security hole. Needs admin permission. Scope: api_keys:read.

Scope
api_keys:read
SDK method
listApiKeys · list_api_keys
MCP tool
listApiKeysread-only

Paginated

Parameters

NameTypeRequiredDescription
limitqueryintegernoPage size (1–200, default 50); 400 if it isn't an integerval 1–200, default 50
cursorquerystringnonext_cursor from the previous response (opaque)

Example request

curl -X GET "https://hiboty.com/api/v1/api-keys?limit=50" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Example response (200)

JSON
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Hiboty",
      "prefix": "string",
      "scopes": [
        "string"
      ],
      "access_level": "string",
      "last_used_at": "2026-11-06T09:00:00.000Z",
      "revoked_at": "2026-11-06T09:00:00.000Z",
      "created_at": "2026-11-06T09:00:00.000Z"
    }
  ],
  "next_cursor": "string"
}

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.

Revokes an API key

DELETE/api/v1/api-keys/{id}

The key stops working immediately; the requesting key can revoke itself. Needs admin permission. Scope: api_keys:write.

Scope
api_keys:write
SDK method
revokeApiKey · revoke_api_key
MCP tool
revokeApiKeyexternal effectirreversible

Parameters

NameTypeRequiredDescription
idpathuuidyesID

Example request

curl -X DELETE "https://hiboty.com/api/v1/api-keys/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Example response (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "deleted": true
  }
}

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.
  • 404The record doesn't exist or this key can't access it (not_found).
  • 429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.

Lists apps connected with OAuth

GET/api/v1/connected-apps

Tokens are never returned. Needs admin permission. Scope: api_keys:read.

Scope
api_keys:read
SDK method
listConnectedApps · list_connected_apps
MCP tool
listConnectedAppsread-only

Paginated

Parameters

NameTypeRequiredDescription
limitqueryintegernoPage size (1–200, default 50); 400 if it isn't an integerval 1–200, default 50
cursorquerystringnonext_cursor from the previous response (opaque)

Example request

curl -X GET "https://hiboty.com/api/v1/connected-apps?limit=50" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Example response (200)

JSON
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Hiboty",
      "scopes": [
        "string"
      ],
      "last_used_at": "2026-11-06T09:00:00.000Z",
      "created_at": "2026-11-06T09:00:00.000Z"
    }
  ],
  "next_cursor": "string"
}

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.

Removes a connected app's access

DELETE/api/v1/connected-apps/{id}

Needs admin permission. Scope: api_keys:write.

Scope
api_keys:write
SDK method
revokeConnectedApp · revoke_connected_app
MCP tool
revokeConnectedAppexternal effectirreversible

Parameters

NameTypeRequiredDescription
idpathuuidyesID

Example request

curl -X DELETE "https://hiboty.com/api/v1/connected-apps/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Example response (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "deleted": true
  }
}

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.
  • 404The record doesn't exist or this key can't access it (not_found).
  • 429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.

API request log

GET/api/v1/usage/requests

Request count, error rate and p95 latency for recent days, with the latest requests (newest first). API key and OAuth requests are logged; 429 responses aren't. The log is kept for 30 days. Needs admin permission. Scope: api_keys:read.

Scope
api_keys:read
SDK method
getApiRequestLog · get_api_request_log
MCP tool
getApiRequestLogread-only

Parameters

NameTypeRequiredDescription
daysqueryintegernoSummary window (days, 1–30, default 7)val 1–30, default 7
limitqueryintegernoNumber of latest requests to return (1–100, default 100)val 1–100, default 100

Example request

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

Example response (200)

JSON
{
  "data": {
    "period_days": 1,
    "total": 1,
    "errors": 1,
    "error_rate": 1,
    "p95_ms": 1,
    "requests": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "method": "string",
        "path": "string",
        "status": 1,
        "duration_ms": 1,
        "credential": {
          "type": "api_key",
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "Hiboty"
        },
        "created_at": "2026-11-06T09:00:00.000Z"
      }
    ]
  }
}

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.yan