API başvurusu

Sistem

Bu gruptaki 3 uç.

Plan ve bu ayın kullanımı

GET/api/v1/usage

Kapsam
read
SDK metodu
getUsage · get_usage
MCP aracı
getUsagesalt okunur

Örnek istek

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

Örnek yanıt (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
    }
  }
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.

Bu OpenAPI belgesi

GET/api/v1/openapi.json

Kapsam
Kimlik gerekmez
SDK metodu
getOpenApi · get_open_api
MCP aracı
MCP aracı yok

Örnek istek

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

Örnek yanıt (200)

JSON
{}

Sağlık kontrolü (kimlik gerekmez)

GET/api/health

Kapsam
Kimlik gerekmez
SDK metodu
health · health
MCP aracı
MCP aracı yok

Parametreler

AdTürZorunluAçıklama
cronsorguenumhayır1 verilirse arka plan işleri durmuşsa da 503 döner1

Örnek istek

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

Örnek yanıt (200)

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

Olası hatalar

  • 503Arka plan işleri durmuş ya da servis geçici olarak kullanılamıyor.