API başvurusu

API anahtarları

Bu gruptaki 5 uç.

API anahtarlarını listeler

GET/api/v1/api-keys

Anahtarın kendisi ve özeti dönmez; yalnız başlangıcı döner. Yeni anahtar yalnız panelde üretilir: bir anahtarın kendinden geniş ya da iptalden etkilenmeyen anahtar üretmesi güvenlik açığı olurdu. Yönetici yetkisi gerekir. Kapsam: api_keys:read.

Kapsam
api_keys:read
SDK metodu
listApiKeys · list_api_keys
MCP aracı
listApiKeyssalt okunur

Sayfalı

Parametreler

AdTürZorunluAçıklama
limitsorguintegerhayırSayfa boyutu (1–200, varsayılan 50); tam sayı değilse 400val 1–200, default 50
cursorsorgustringhayırÖnceki yanıttaki next_cursor (opak)

Örnek istek

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

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

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.

API anahtarını iptal eder

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

Anahtar hemen çalışmaz olur; isteği yapan anahtar da iptal edilebilir. Yönetici yetkisi gerekir. Kapsam: api_keys:write.

Kapsam
api_keys:write
SDK metodu
revokeApiKey · revoke_api_key
MCP aracı
revokeApiKeydış etkiligeri alınamaz

Parametreler

AdTürZorunluAçıklama
idyoluuidevetid kimliği

Örnek istek

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

Örnek yanıt (200)

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

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.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 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.

OAuth ile bağlı uygulamaları listeler

GET/api/v1/connected-apps

Belirteçler dönmez. Yönetici yetkisi gerekir. Kapsam: api_keys:read.

Kapsam
api_keys:read
SDK metodu
listConnectedApps · list_connected_apps
MCP aracı
listConnectedAppssalt okunur

Sayfalı

Parametreler

AdTürZorunluAçıklama
limitsorguintegerhayırSayfa boyutu (1–200, varsayılan 50); tam sayı değilse 400val 1–200, default 50
cursorsorgustringhayırÖnceki yanıttaki next_cursor (opak)

Örnek istek

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

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

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.

Bağlı uygulamanın erişimini kaldırır

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

Yönetici yetkisi gerekir. Kapsam: api_keys:write.

Kapsam
api_keys:write
SDK metodu
revokeConnectedApp · revoke_connected_app
MCP aracı
revokeConnectedAppdış etkiligeri alınamaz

Parametreler

AdTürZorunluAçıklama
idyoluuidevetid kimliği

Örnek istek

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

Örnek yanıt (200)

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

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.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 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.

API istek günlüğü

GET/api/v1/usage/requests

Son günlerin istek sayısı, hata oranı ve p95 süresi ile son istekler (yeniden eskiye). API anahtarı ve OAuth istekleri kaydedilir; 429 yanıtları kaydedilmez. Günlük 30 gün saklanır. Yönetici yetkisi gerekir. Kapsam: api_keys:read.

Kapsam
api_keys:read
SDK metodu
getApiRequestLog · get_api_request_log
MCP aracı
getApiRequestLogsalt okunur

Parametreler

AdTürZorunluAçıklama
dayssorguintegerhayırÖzet aralığı (gün, 1–30, varsayılan 7)val 1–30, default 7
limitsorguintegerhayırDönecek son istek sayısı (1–100, varsayılan 100)val 1–100, default 100

Örnek istek

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

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

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