API başvurusu

Botlar

Bu gruptaki 68 uç.

Organizasyonun botlarını listeler

GET/api/v1/bots

Kapsam
read
SDK metodu
listBots · list_bots
MCP aracı
listBotssalt okunur

Sayfalı

Parametreler

AdTürZorunluAçıklama
limitsorguintegerhayırSayfa boyutu (1–200, varsayılan 100); tam sayı değilse 400val 1–200, default 100
cursorsorgustringhayırÖnceki yanıttaki next_cursor (opak; eski date-time imleçleri de kabul edilir)

Örnek istek

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

Örnek yanıt (200)

JSON
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Hiboty",
      "channel": "telegram",
      "status": "string",
      "telegram_username": "string",
      "whatsapp_phone": "string",
      "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.

Bot oluşturur

POST/api/v1/bots

Plan bot sınırı panelle aynıdır (403 plan_limit). template verilirse boş bırakılan persona, karşılama, temsilci kelimesi ve faqs galeri şablonundan gelir (language: şablon dili). Bot taslak (draft) oluşur; connectBot ile kanala bağlanır. Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
createBot · create_bot
MCP aracı
createBot

Idempotency-Key destekli

Parametreler

AdTürZorunluAçıklama
Idempotency-Keybaşlıkstringhayırİsteğe bağlı, 1-255 görünür ASCII karakter. Organizasyon + uç + anahtar başına 24 saat geçerlidir: aynı anahtar ve aynı gövdeyle ilk yanıt aynen döner (Idempotency-Replayed: true), işlem tekrarlanmaz. Farklı gövdede 409 idempotency_conflict; ilk istek sürerken 409 idempotency_in_progress ve Retry-After. 5xx ve 429 yanıtları saklanmaz, aynı anahtarla yeniden denenebilir.len 1–255

Gövde alanları

AdTürZorunluAçıklama
namestringevetlen 2–80
channelenumevettelegram | whatsapp
templateenumhayırGaleri şablonu (listBotTemplates)eticaret | restoran | randevu | egitim | destek | guzellik | klinik | emlak | otel | otomotiv | etkinlik | spor
languageenumhayırŞablon ve SSS dili; verilmezse isteğin dilitr | en
faqsobject[]hayırVerilirse şablonun SSS'lerinin yerine geçeritems ≤ 10
faqs[].questionstringevetlen 2–160
faqs[].answerstringevetlen 1–2000
personastringhayırlen ≤ 6000
welcome_messagestringhayırlen ≤ 1000
handoff_keywordstringhayırlen 2–40
ai_enabledbooleanhayırdefault true
voice_transcriptionbooleanhayırdefault false
image_understandingbooleanhayırdefault false
ai_toolsbooleanhayırdefault true

Örnek istek

curl -X POST "https://hiboty.com/api/v1/bots" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Idempotency-Key: order-10482" \
  -H "Content-Type: application/json" \
  -d '{"name":"Mağaza Asistanı","channel":"telegram","template":"eticaret","language":"tr"}'

Örnek yanıt (201)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Hiboty",
    "channel": "telegram",
    "status": "draft",
    "connected": true,
    "persona": "string",
    "welcome_message": "string",
    "handoff_keyword": "string",
    "ai_enabled": true,
    "voice_transcription": true,
    "image_understanding": true,
    "ai_tools": true,
    "voice_reply": "kapali",
    "reply_language": "tr",
    "appointment_tool": true,
    "cancel_request_tool": true,
    "show_source_links": true,
    "telegram_username": "string",
    "whatsapp_phone": "string",
    "whatsapp_phone_number_id": "string",
    "whatsapp_business_account_id": "string",
    "whatsapp_embedded": true,
    "whatsapp_app_secret_set": true,
    "webhook_url": "https://example.com/a.png",
    "webhook_verified_at": "2026-11-06T09:00:00.000Z",
    "last_webhook_at": "2026-11-06T09:00:00.000Z",
    "last_error": "string",
    "whatsapp_quality": "GREEN",
    "whatsapp_messaging_limit": "string",
    "whatsapp_quality_at": "2026-11-06T09:00:00.000Z",
    "delivery_score": 0,
    "delivery_score_reasons": [
      "veri_az"
    ],
    "delivery_score_at": "2026-11-06T09:00:00.000Z",
    "whatsapp_account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "created_at": "2026-11-06T09:00:00.000Z",
    "updated_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.plan_limit
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.
  • 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.

Galeri şablonlarını listeler

GET/api/v1/bots/templates

createBot için template kodları. Kapsam: bots:read.

Kapsam
bots:read
SDK metodu
listBotTemplates · list_bot_templates
MCP aracı
listBotTemplatessalt okunur

Parametreler

AdTürZorunluAçıklama
sectorsorguenumhayırSektör süzgeciperakende | yeme_icme | hizmet | saglik | emlak | turizm | egitim | genel
languagesorguenumhayırMetin dili; verilmezse isteğin dilitr | en

Örnek istek

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

Örnek yanıt (200)

JSON
{
  "data": [
    {
      "code": "ornek",
      "sector": "string",
      "name": "Hiboty",
      "description": "string",
      "persona": "string",
      "welcome_message": "string",
      "handoff_keyword": "string",
      "faqs": [
        {
          "question": "string",
          "answer": "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.

AI ile bot taslağı üretir (kayıt yapmaz)

POST/api/v1/bots/draft

Açıklama ya da site adresinden persona, karşılama ve SSS önerir; sonucu createBot ile kaydedin. Site adresi SSRF denetiminden geçer. AI kotasından düşer. Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
createBotDraft · create_bot_draft
MCP aracı
createBotDraftdış etkili

Gövde alanları

AdTürZorunluAçıklama
descriptionstringhayırlen ≤ 3000
websitestringhayırlen ≤ 2000

Örnek istek

curl -X POST "https://hiboty.com/api/v1/bots/draft" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"description":"İstanbul'\''da el yapımı seramik satan bir online mağaza.","website":"https://ornek.com"}'

Örnek yanıt (200)

JSON
{
  "data": {
    "persona": "string",
    "welcome_message": "string",
    "faqs": [
      {
        "question": "string",
        "answer": "string"
      }
    ],
    "website_error": "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.
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.
  • 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.
  • 502Kanal ya da dış servis hatası (channel_error).

Bot dosyasından yeni taslak bot oluşturur

POST/api/v1/bots/import

Dosya baştan doğrulanır, kanal bağlanmaz, araçlar kapalı gelir. Araç imza sırları yalnız bu yanıtta döner. Plan bot sınırı geçerlidir. Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
importBot · import_bot
MCP aracı
importBot

Idempotency-Key destekli

Parametreler

AdTürZorunluAçıklama
Idempotency-Keybaşlıkstringhayırİsteğe bağlı, 1-255 görünür ASCII karakter. Organizasyon + uç + anahtar başına 24 saat geçerlidir: aynı anahtar ve aynı gövdeyle ilk yanıt aynen döner (Idempotency-Replayed: true), işlem tekrarlanmaz. Farklı gövdede 409 idempotency_conflict; ilk istek sürerken 409 idempotency_in_progress ve Retry-After. 5xx ve 429 yanıtları saklanmaz, aynı anahtarla yeniden denenebilir.len 1–255

Gövde alanları

AdTürZorunluAçıklama
fileobject | stringevetexportBot'un döndürdüğü dosya (nesne ya da JSON metni), en fazla 512 KB

Örnek istek

curl -X POST "https://hiboty.com/api/v1/bots/import" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Idempotency-Key: order-10482" \
  -H "Content-Type: application/json" \
  -d '{"file":{"tur":"hiboty.bot","surum":1}}'

Örnek yanıt (201)

JSON
{
  "data": {
    "bot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Hiboty",
    "knowledge_count": 1,
    "tools": [
      {
        "name": "Hiboty",
        "signing_secret": "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.
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.
  • 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.

Bot dosyasını doğrular, kaydetmez

POST/api/v1/bots/import/preview

Ne oluşacağını, dosyadaki adresleri ve görünmez karakterli alanları döner. Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
previewBotImport · preview_bot_import
MCP aracı
previewBotImport

Gövde alanları

AdTürZorunluAçıklama
fileobject | stringevetexportBot'un döndürdüğü dosya (nesne ya da JSON metni), en fazla 512 KB

Örnek istek

curl -X POST "https://hiboty.com/api/v1/bots/import/preview" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"file":{"tur":"hiboty.bot","surum":1}}'

Örnek yanıt (200)

JSON
{
  "data": {
    "name": "Hiboty",
    "channel": "telegram",
    "knowledge_count": 1,
    "tool_count": 1,
    "addresses": [
      {
        "type": "tool",
        "name": "Hiboty",
        "url": "https://example.com/hook",
        "has_query": true
      }
    ],
    "invisible_character_fields": [
      "string"
    ],
    "oversized_sources": [
      "string"
    ],
    "bot_count": 1,
    "bot_limit": 1,
    "bot": {
      "persona": "string",
      "welcome_message": "string",
      "handoff_keyword": "string",
      "ai_enabled": true,
      "ai_tools": true,
      "voice_transcription": true,
      "image_understanding": true
    },
    "knowledge": [
      {
        "type": "text",
        "title": "Örnek",
        "url": "https://example.com/hook",
        "content": "string"
      }
    ],
    "tools": [
      {
        "name": "Hiboty",
        "description": "string",
        "url": "https://example.com/hook",
        "fields": [
          {
            "name": "Hiboty",
            "type": "string",
            "required": false,
            "description": "string",
            "options": []
          }
        ]
      }
    ]
  }
}

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.

Bot ayrıntısı

GET/api/v1/bots/{id}

Jeton ve sırlar dönmez; yalnız connected bilgisi döner. Kapsam: bots:read.

Kapsam
bots:read
SDK metodu
getBot · get_bot
MCP aracı
getBotsalt okunur

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği

Örnek istek

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

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Hiboty",
    "channel": "telegram",
    "status": "draft",
    "connected": true,
    "persona": "string",
    "welcome_message": "string",
    "handoff_keyword": "string",
    "ai_enabled": true,
    "voice_transcription": true,
    "image_understanding": true,
    "ai_tools": true,
    "voice_reply": "kapali",
    "reply_language": "tr",
    "appointment_tool": true,
    "cancel_request_tool": true,
    "show_source_links": true,
    "telegram_username": "string",
    "whatsapp_phone": "string",
    "whatsapp_phone_number_id": "string",
    "whatsapp_business_account_id": "string",
    "whatsapp_embedded": true,
    "whatsapp_app_secret_set": true,
    "webhook_url": "https://example.com/a.png",
    "webhook_verified_at": "2026-11-06T09:00:00.000Z",
    "last_webhook_at": "2026-11-06T09:00:00.000Z",
    "last_error": "string",
    "whatsapp_quality": "GREEN",
    "whatsapp_messaging_limit": "string",
    "whatsapp_quality_at": "2026-11-06T09:00:00.000Z",
    "delivery_score": 0,
    "delivery_score_reasons": [
      "veri_az"
    ],
    "delivery_score_at": "2026-11-06T09:00:00.000Z",
    "whatsapp_account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "created_at": "2026-11-06T09:00:00.000Z",
    "updated_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.
  • 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.

Bot ve AI ayarlarını günceller

PATCH/api/v1/bots/{id}

Yalnız gönderilen alanlar değişir; önceki hâl sürüm olarak saklanır (listBotVersions). Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
updateBot · update_bot
MCP aracı
updateBot

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği

Gövde alanları

AdTürZorunluAçıklama
namestringhayırlen 2–80
personastringhayırlen ≤ 6000
welcome_messagestringhayırlen ≤ 1000
handoff_keywordstringhayırlen 2–40
ai_enabledbooleanhayır
voice_transcriptionbooleanhayır
image_understandingbooleanhayır
ai_toolsbooleanhayır
voice_replyenumhayırSesli yanıt (TTS) ayarı; sürüm geçmişine girmez.kapali | sesliye_sesli | her_zaman
reply_languageenumhayırSabit yanıt dili; null otomatik. Sürüm geçmişine girmez.tr | en | de | fr | es | it | pt | nl | ru | ar | az | null
appointment_toolbooleanhayırRandevu talebi aracı; sürüm geçmişine girmez.
cancel_request_toolbooleanhayırSipariş iptal talebi aracı; sürüm geçmişine girmez.
show_source_linksbooleanhayırMüşteriye kaynak bağlantısı gösterme; sürüm geçmişine girmez.

Örnek istek

curl -X PATCH "https://hiboty.com/api/v1/bots/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"persona":"Kısa ve net yanıt veren satış asistanısın.","ai_enabled":true}'

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Hiboty",
    "channel": "telegram",
    "status": "draft",
    "connected": true,
    "persona": "string",
    "welcome_message": "string",
    "handoff_keyword": "string",
    "ai_enabled": true,
    "voice_transcription": true,
    "image_understanding": true,
    "ai_tools": true,
    "voice_reply": "kapali",
    "reply_language": "tr",
    "appointment_tool": true,
    "cancel_request_tool": true,
    "show_source_links": true,
    "telegram_username": "string",
    "whatsapp_phone": "string",
    "whatsapp_phone_number_id": "string",
    "whatsapp_business_account_id": "string",
    "whatsapp_embedded": true,
    "whatsapp_app_secret_set": true,
    "webhook_url": "https://example.com/a.png",
    "webhook_verified_at": "2026-11-06T09:00:00.000Z",
    "last_webhook_at": "2026-11-06T09:00:00.000Z",
    "last_error": "string",
    "whatsapp_quality": "GREEN",
    "whatsapp_messaging_limit": "string",
    "whatsapp_quality_at": "2026-11-06T09:00:00.000Z",
    "delivery_score": 0,
    "delivery_score_reasons": [
      "veri_az"
    ],
    "delivery_score_at": "2026-11-06T09:00:00.000Z",
    "whatsapp_account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "created_at": "2026-11-06T09:00:00.000Z",
    "updated_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.
  • 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.

Botu siler

DELETE/api/v1/bots/{id}

Geri alınamaz; kişi ve sohbetleri de silinir. Panel gibi yalnız sahip yetkisiyle çalışır (403 forbidden_role). Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
deleteBot · delete_bot
MCP aracı
deleteBotdış etkiligeri alınamaz

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği

Örnek istek

curl -X DELETE "https://hiboty.com/api/v1/bots/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.forbidden_role
  • 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.

Botu kanala bağlar

POST/api/v1/bots/{id}/connect

Telegram: token. WhatsApp Cloud API: phone_number_id, business_account_id, access_token ve (kayıtlı değilse) app_secret; Meta webhook doğrulaması için kendi webhook_verify_token değerinizi verebilirsiniz, yanıt bu değeri döndürmez. Bilgiler panelle aynı doğrulanır, şifreli saklanır, Telegram webhook'u kurulur. Yanıt ve hatalarda gizli değer yoktur. warning: whatsapp_subscription_failed ise bağlantı kaydedilmiş ama uygulama WABA'ya abone edilememiştir. Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
connectBot · connect_bot
MCP aracı
connectBotdış etkili

Idempotency-Key destekli

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği
Idempotency-Keybaşlıkstringhayırİsteğe bağlı, 1-255 görünür ASCII karakter. Organizasyon + uç + anahtar başına 24 saat geçerlidir: aynı anahtar ve aynı gövdeyle ilk yanıt aynen döner (Idempotency-Replayed: true), işlem tekrarlanmaz. Farklı gövdede 409 idempotency_conflict; ilk istek sürerken 409 idempotency_in_progress ve Retry-After. 5xx ve 429 yanıtları saklanmaz, aynı anahtarla yeniden denenebilir.len 1–255

Gövde alanları

AdTürZorunluAçıklama
tokenstringhayırBotFather jetonu
phone_number_idstringhayır
business_account_idstringhayır
access_tokenstringhayırlen ≥ 20
app_secretstringhayır
webhook_verify_tokenstringhayırMeta webhook doğrulaması için seçtiğiniz değer; hiçbir yanıtta dönmezlen 16–128
business_idstringhayırİsteğe bağlı Meta işletme portföyü kimliği; WhatsApp hesabı (WABA) kaydına yazılır

Örnek istek

curl -X POST "https://hiboty.com/api/v1/bots/3fa85f64-5717-4562-b3fc-2c963f66afa6/connect" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Idempotency-Key: order-10482" \
  -H "Content-Type: application/json" \
  -d '{"token":"123456789:AAExampleExampleExampleExampleExample"}'

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Hiboty",
    "channel": "telegram",
    "status": "draft",
    "connected": true,
    "persona": "string",
    "welcome_message": "string",
    "handoff_keyword": "string",
    "ai_enabled": true,
    "voice_transcription": true,
    "image_understanding": true,
    "ai_tools": true,
    "voice_reply": "kapali",
    "reply_language": "tr",
    "appointment_tool": true,
    "cancel_request_tool": true,
    "show_source_links": true,
    "telegram_username": "string",
    "whatsapp_phone": "string",
    "whatsapp_phone_number_id": "string",
    "whatsapp_business_account_id": "string",
    "whatsapp_embedded": true,
    "whatsapp_app_secret_set": true,
    "webhook_url": "https://example.com/a.png",
    "webhook_verified_at": "2026-11-06T09:00:00.000Z",
    "last_webhook_at": "2026-11-06T09:00:00.000Z",
    "last_error": "string",
    "whatsapp_quality": "GREEN",
    "whatsapp_messaging_limit": "string",
    "whatsapp_quality_at": "2026-11-06T09:00:00.000Z",
    "delivery_score": 0,
    "delivery_score_reasons": [
      "veri_az"
    ],
    "delivery_score_at": "2026-11-06T09:00:00.000Z",
    "whatsapp_account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "created_at": "2026-11-06T09:00:00.000Z",
    "updated_at": "2026-11-06T09:00:00.000Z",
    "warning": "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.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.
  • 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.
  • 502Kanal ya da dış servis hatası (channel_error).

Kanal bağlantısını kaldırır

POST/api/v1/bots/{id}/disconnect

Telegram webhook'u silinir, jetonlar silinir, bot taslağa döner; kişi ve sohbetler korunur. Bağlı değilse 409 not_connected. Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
disconnectBot · disconnect_bot
MCP aracı
disconnectBotdış etkiligeri alınamaz

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği

Örnek istek

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

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Hiboty",
    "channel": "telegram",
    "status": "draft",
    "connected": true,
    "persona": "string",
    "welcome_message": "string",
    "handoff_keyword": "string",
    "ai_enabled": true,
    "voice_transcription": true,
    "image_understanding": true,
    "ai_tools": true,
    "voice_reply": "kapali",
    "reply_language": "tr",
    "appointment_tool": true,
    "cancel_request_tool": true,
    "show_source_links": true,
    "telegram_username": "string",
    "whatsapp_phone": "string",
    "whatsapp_phone_number_id": "string",
    "whatsapp_business_account_id": "string",
    "whatsapp_embedded": true,
    "whatsapp_app_secret_set": true,
    "webhook_url": "https://example.com/a.png",
    "webhook_verified_at": "2026-11-06T09:00:00.000Z",
    "last_webhook_at": "2026-11-06T09:00:00.000Z",
    "last_error": "string",
    "whatsapp_quality": "GREEN",
    "whatsapp_messaging_limit": "string",
    "whatsapp_quality_at": "2026-11-06T09:00:00.000Z",
    "delivery_score": 0,
    "delivery_score_reasons": [
      "veri_az"
    ],
    "delivery_score_at": "2026-11-06T09:00:00.000Z",
    "whatsapp_account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "created_at": "2026-11-06T09:00:00.000Z",
    "updated_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.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.not_connected
  • 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.

Botu duraklatır

POST/api/v1/bots/{id}/pause

Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
pauseBot · pause_bot
MCP aracı
pauseBotdış etkili

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği

Örnek istek

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

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Hiboty",
    "channel": "telegram",
    "status": "draft",
    "connected": true,
    "persona": "string",
    "welcome_message": "string",
    "handoff_keyword": "string",
    "ai_enabled": true,
    "voice_transcription": true,
    "image_understanding": true,
    "ai_tools": true,
    "voice_reply": "kapali",
    "reply_language": "tr",
    "appointment_tool": true,
    "cancel_request_tool": true,
    "show_source_links": true,
    "telegram_username": "string",
    "whatsapp_phone": "string",
    "whatsapp_phone_number_id": "string",
    "whatsapp_business_account_id": "string",
    "whatsapp_embedded": true,
    "whatsapp_app_secret_set": true,
    "webhook_url": "https://example.com/a.png",
    "webhook_verified_at": "2026-11-06T09:00:00.000Z",
    "last_webhook_at": "2026-11-06T09:00:00.000Z",
    "last_error": "string",
    "whatsapp_quality": "GREEN",
    "whatsapp_messaging_limit": "string",
    "whatsapp_quality_at": "2026-11-06T09:00:00.000Z",
    "delivery_score": 0,
    "delivery_score_reasons": [
      "veri_az"
    ],
    "delivery_score_at": "2026-11-06T09:00:00.000Z",
    "whatsapp_account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "created_at": "2026-11-06T09:00:00.000Z",
    "updated_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.
  • 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.

Botu sürdürür

POST/api/v1/bots/{id}/resume

Kanal bağlı değilse 409 not_connected. Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
resumeBot · resume_bot
MCP aracı
resumeBotdış etkili

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği

Örnek istek

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

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Hiboty",
    "channel": "telegram",
    "status": "draft",
    "connected": true,
    "persona": "string",
    "welcome_message": "string",
    "handoff_keyword": "string",
    "ai_enabled": true,
    "voice_transcription": true,
    "image_understanding": true,
    "ai_tools": true,
    "voice_reply": "kapali",
    "reply_language": "tr",
    "appointment_tool": true,
    "cancel_request_tool": true,
    "show_source_links": true,
    "telegram_username": "string",
    "whatsapp_phone": "string",
    "whatsapp_phone_number_id": "string",
    "whatsapp_business_account_id": "string",
    "whatsapp_embedded": true,
    "whatsapp_app_secret_set": true,
    "webhook_url": "https://example.com/a.png",
    "webhook_verified_at": "2026-11-06T09:00:00.000Z",
    "last_webhook_at": "2026-11-06T09:00:00.000Z",
    "last_error": "string",
    "whatsapp_quality": "GREEN",
    "whatsapp_messaging_limit": "string",
    "whatsapp_quality_at": "2026-11-06T09:00:00.000Z",
    "delivery_score": 0,
    "delivery_score_reasons": [
      "veri_az"
    ],
    "delivery_score_at": "2026-11-06T09:00:00.000Z",
    "whatsapp_account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "created_at": "2026-11-06T09:00:00.000Z",
    "updated_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.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.not_connected
  • 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.

Canlıya hazırlık denetimi

GET/api/v1/bots/{id}/readiness

Kapsam: bots:read.

Kapsam
bots:read
SDK metodu
getBotReadiness · get_bot_readiness
MCP aracı
getBotReadinesssalt okunur

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği

Örnek istek

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

Örnek yanıt (200)

JSON
{
  "data": {
    "ready": true,
    "items": [
      {
        "key": "sehir",
        "status": "tamam",
        "group": "kanal",
        "count": [
          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.
  • 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.

Bot dosyasını dışa aktarır

GET/api/v1/bots/{id}/export

Yapılandırma, bilgi kaynakları ve araç tanımları; kanal bilgisi ve sırlar dosyaya girmez. Yönetici yetkisi gerekir. Kapsam: bots:read.

Kapsam
bots:read
SDK metodu
exportBot · export_bot
MCP aracı
exportBotsalt okunur

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği

Örnek istek

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

Örnek yanıt (200)

JSON
{
  "data": {
    "file_name": "string",
    "file": {},
    "knowledge_count": 1,
    "tool_count": 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.
  • 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.

AI yanıtını dener

POST/api/v1/bots/{id}/ai-test

Kişiye mesaj gitmez, sohbet açılmaz; yanıt test olarak AI kotasından düşer. Son 20 mesaj kullanılır. Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
testBotReply · test_bot_reply
MCP aracı
testBotReply

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği

Gövde alanları

AdTürZorunluAçıklama
messagesobject[]evetitems 1–50
messages[].roleenumevetuser | assistant
messages[].contentstringevetlen 1–4000

Örnek istek

curl -X POST "https://hiboty.com/api/v1/bots/3fa85f64-5717-4562-b3fc-2c963f66afa6/ai-test" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"messages":[{"role":"user","content":"Kargom ne zaman gelir?"}]}'

Örnek yanıt (200)

JSON
{
  "data": {
    "reply": "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.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.
  • 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.
  • 502Kanal ya da dış servis hatası (channel_error).

Bilgi kaynaklarını listeler

GET/api/v1/bots/{id}/knowledge

İçerik yerine uzunluk döner. Kapsam: bots:read.

Kapsam
bots:read
SDK metodu
listKnowledgeSources · list_knowledge_sources
MCP aracı
listKnowledgeSourcessalt okunur

Sayfalı

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği
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; eski date-time imleçleri de kabul edilir)

Örnek istek

curl -X GET "https://hiboty.com/api/v1/bots/3fa85f64-5717-4562-b3fc-2c963f66afa6/knowledge?limit=50" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Örnek yanıt (200)

JSON
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "bot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": "text",
      "title": "Örnek",
      "length": 1,
      "url": "https://example.com/hook",
      "status": "string",
      "freshness": "taze",
      "last_error": "string",
      "fetched_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.
  • 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.

Bilgi kaynağı ekler

POST/api/v1/bots/{id}/knowledge

type: text (content), faq (question, answer), url (herkese açık sayfa; özel ağ adresleri reddedilir, 400 source_fetch_failed) ya da file (file_name ve file_base64; yalnız UTF-8 metin dosyaları, en fazla 256 KB). Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
createKnowledgeSource · create_knowledge_source
MCP aracı
createKnowledgeSourcedış etkili

Idempotency-Key destekli

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği
Idempotency-Keybaşlıkstringhayırİsteğe bağlı, 1-255 görünür ASCII karakter. Organizasyon + uç + anahtar başına 24 saat geçerlidir: aynı anahtar ve aynı gövdeyle ilk yanıt aynen döner (Idempotency-Replayed: true), işlem tekrarlanmaz. Farklı gövdede 409 idempotency_conflict; ilk istek sürerken 409 idempotency_in_progress ve Retry-After. 5xx ve 429 yanıtları saklanmaz, aynı anahtarla yeniden denenebilir.len 1–255

Gövde alanları

AdTürZorunluAçıklama
typeenumevettext | faq | url | file
titlestringevetlen 2–160
contentstringhayırtype=textlen 10–60000
questionstringhayırtype=faqlen ≤ 500
answerstringhayırtype=faqlen ≤ 5000
urlurihayırtype=url; herkese açık http/https sayfalen ≤ 2000
file_namestringhayırtype=file; txt, md, csv, tsv, json, htmllen ≤ 200
file_base64stringhayırtype=file; UTF-8 metin dosyasının base64 içeriği, en fazla 256 KB

Örnek istek

curl -X POST "https://hiboty.com/api/v1/bots/3fa85f64-5717-4562-b3fc-2c963f66afa6/knowledge" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Idempotency-Key: order-10482" \
  -H "Content-Type: application/json" \
  -d '{"type":"faq","title":"Kargo süresi","question":"Kargom ne zaman gelir?","answer":"1-3 iş günü içinde kargoya verilir."}'

Örnek yanıt (201)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "text",
    "title": "Örnek",
    "length": 1,
    "url": "https://example.com/hook",
    "status": "string",
    "freshness": "taze",
    "last_error": "string",
    "fetched_at": "2026-11-06T09:00:00.000Z",
    "created_at": "2026-11-06T09:00:00.000Z",
    "content": "string",
    "question": "string",
    "answer": "string",
    "changed": true
  }
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).source_fetch_failed
  • 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).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.
  • 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.

Bilgi kaynağının içeriği

GET/api/v1/bots/{id}/knowledge/{source_id}

Kapsam: bots:read.

Kapsam
bots:read
SDK metodu
getKnowledgeSource · get_knowledge_source
MCP aracı
getKnowledgeSourcesalt okunur

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği
source_idyoluuidevetKaynak kimliği

Örnek istek

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

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "text",
    "title": "Örnek",
    "length": 1,
    "url": "https://example.com/hook",
    "status": "string",
    "freshness": "taze",
    "last_error": "string",
    "fetched_at": "2026-11-06T09:00:00.000Z",
    "created_at": "2026-11-06T09:00:00.000Z",
    "content": "string",
    "question": "string",
    "answer": "string",
    "changed": 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.

Bilgi kaynağını günceller

PATCH/api/v1/bots/{id}/knowledge/{source_id}

URL kaynağında yalnız başlık değişir. SSS kaynağında question ve answer gerekir. Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
updateKnowledgeSource · update_knowledge_source
MCP aracı
updateKnowledgeSource

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği
source_idyoluuidevetKaynak kimliği

Gövde alanları

AdTürZorunluAçıklama
titlestringevetlen 2–160
contentstringhayırlen ≤ 60000
questionstringhayırlen ≤ 500
answerstringhayırlen ≤ 5000

Örnek istek

curl -X PATCH "https://hiboty.com/api/v1/bots/3fa85f64-5717-4562-b3fc-2c963f66afa6/knowledge/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"İade koşulları","content":"İade süresi teslimden itibaren 14 gündür."}'

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "text",
    "title": "Örnek",
    "length": 1,
    "url": "https://example.com/hook",
    "status": "string",
    "freshness": "taze",
    "last_error": "string",
    "fetched_at": "2026-11-06T09:00:00.000Z",
    "created_at": "2026-11-06T09:00:00.000Z",
    "content": "string",
    "question": "string",
    "answer": "string",
    "changed": 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.

Bilgi kaynağını siler

DELETE/api/v1/bots/{id}/knowledge/{source_id}

Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
deleteKnowledgeSource · delete_knowledge_source
MCP aracı
deleteKnowledgeSourcegeri alınamaz

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği
source_idyoluuidevetKaynak kimliği

Örnek istek

curl -X DELETE "https://hiboty.com/api/v1/bots/3fa85f64-5717-4562-b3fc-2c963f66afa6/knowledge/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.

URL kaynağını yeniden çeker

POST/api/v1/bots/{id}/knowledge/{source_id}/refresh

Organizasyon başına saatte en fazla 20. Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
refreshKnowledgeSource · refresh_knowledge_source
MCP aracı
refreshKnowledgeSourcedış etkili

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği
source_idyoluuidevetURL kaynağının kimliği

Örnek istek

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

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "text",
    "title": "Örnek",
    "length": 1,
    "url": "https://example.com/hook",
    "status": "string",
    "freshness": "taze",
    "last_error": "string",
    "fetched_at": "2026-11-06T09:00:00.000Z",
    "created_at": "2026-11-06T09:00:00.000Z",
    "content": "string",
    "question": "string",
    "answer": "string",
    "changed": 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.

Özel AI araçlarını listeler

GET/api/v1/bots/{id}/tools

Gizli başlık değeri ve imza sırrı dönmez. Kapsam: bots:read.

Kapsam
bots:read
SDK metodu
listBotTools · list_bot_tools
MCP aracı
listBotToolssalt okunur

Sayfalı

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği
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; eski date-time imleçleri de kabul edilir)

Örnek istek

curl -X GET "https://hiboty.com/api/v1/bots/3fa85f64-5717-4562-b3fc-2c963f66afa6/tools?limit=50" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Örnek yanıt (200)

JSON
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Hiboty",
      "description": "string",
      "fields": [
        {
          "name": "Hiboty",
          "type": "string",
          "required": false,
          "description": "string",
          "options": [
            "string"
          ]
        }
      ],
      "url": "https://example.com/hook",
      "host": "string",
      "secret_header_name": "string",
      "enabled": true,
      "last_called_at": "2026-11-06T09:00:00.000Z",
      "last_status": 1,
      "signing_secret": "string"
    }
  ],
  "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.
  • 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.

Özel AI aracı ekler

POST/api/v1/bots/{id}/tools

Adres https olmalı, özel ağ adresleri reddedilir. Bot başına en fazla 10 araç. İmza sırrı (signing_secret) yalnız bu yanıtta döner. Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
createBotTool · create_bot_tool
MCP aracı
createBotTooldış etkili

Idempotency-Key destekli

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği
Idempotency-Keybaşlıkstringhayırİsteğe bağlı, 1-255 görünür ASCII karakter. Organizasyon + uç + anahtar başına 24 saat geçerlidir: aynı anahtar ve aynı gövdeyle ilk yanıt aynen döner (Idempotency-Replayed: true), işlem tekrarlanmaz. Farklı gövdede 409 idempotency_conflict; ilk istek sürerken 409 idempotency_in_progress ve Retry-After. 5xx ve 429 yanıtları saklanmaz, aynı anahtarla yeniden denenebilir.len 1–255

Gövde alanları

AdTürZorunluAçıklama
namestringevet
descriptionstringevetlen 10–1000
fieldsobject[]hayıritems ≤ 12
fields[].namestringevet
fields[].typeenumevetstring | number | boolean | enum
fields[].requiredbooleanhayırdefault false
fields[].descriptionstringhayırlen ≤ 300
fields[].optionsstring[]hayıritems ≤ 20
urlurievetHerkese açık https adresi
secret_header_namestringhayırlen ≤ 60
secret_header_valuestringhayırlen ≤ 2000
enabledbooleanhayırdefault true

Örnek istek

curl -X POST "https://hiboty.com/api/v1/bots/3fa85f64-5717-4562-b3fc-2c963f66afa6/tools" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Idempotency-Key: order-10482" \
  -H "Content-Type: application/json" \
  -d '{"name":"stok_sorgula","description":"Ürün stok durumunu sorgular.","url":"https://ornek.com/stok","fields":[{"name":"urun_kodu","type":"string","required":true,"description":"Ürün kodu"}]}'

Örnek yanıt (201)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Hiboty",
    "description": "string",
    "fields": [
      {
        "name": "Hiboty",
        "type": "string",
        "required": false,
        "description": "string",
        "options": [
          "string"
        ]
      }
    ],
    "url": "https://example.com/hook",
    "host": "string",
    "secret_header_name": "string",
    "enabled": true,
    "last_called_at": "2026-11-06T09:00:00.000Z",
    "last_status": 1,
    "signing_secret": "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.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.
  • 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.

Özel AI aracını günceller

PATCH/api/v1/bots/{id}/tools/{tool_id}

Yalnız gönderilen alanlar değişir; imza sırrı değişmez, secret_header_value gönderilmezse mevcut değer korunur. Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
updateBotTool · update_bot_tool
MCP aracı
updateBotTooldış etkili

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği
tool_idyoluuidevetAraç kimliği

Gövde alanları

AdTürZorunluAçıklama
namestringhayır
descriptionstringhayır
fieldsobject[]hayıritems ≤ 12
fields[].namestringevet
fields[].typeenumevetstring | number | boolean | enum
fields[].requiredbooleanhayırdefault false
fields[].descriptionstringhayırlen ≤ 300
fields[].optionsstring[]hayıritems ≤ 20
urlurihayır
secret_header_namestringhayır
secret_header_valuestringhayır
remove_secret_headerbooleanhayır
enabledbooleanhayır

Örnek istek

curl -X PATCH "https://hiboty.com/api/v1/bots/3fa85f64-5717-4562-b3fc-2c963f66afa6/tools/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled":false}'

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Hiboty",
    "description": "string",
    "fields": [
      {
        "name": "Hiboty",
        "type": "string",
        "required": false,
        "description": "string",
        "options": [
          "string"
        ]
      }
    ],
    "url": "https://example.com/hook",
    "host": "string",
    "secret_header_name": "string",
    "enabled": true,
    "last_called_at": "2026-11-06T09:00:00.000Z",
    "last_status": 1,
    "signing_secret": "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.
  • 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.

Özel AI aracını siler

DELETE/api/v1/bots/{id}/tools/{tool_id}

Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
deleteBotTool · delete_bot_tool
MCP aracı
deleteBotToolgeri alınamaz

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği
tool_idyoluuidevetAraç kimliği

Örnek istek

curl -X DELETE "https://hiboty.com/api/v1/bots/3fa85f64-5717-4562-b3fc-2c963f66afa6/tools/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.

Özel aracı örnek girdiyle çağırır

POST/api/v1/bots/{id}/tools/{tool_id}/test

Müşterinin adresine gerçek istek gider (X-Hiboty-Test başlığıyla); kişi ve sohbet kimliği gönderilmez. Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
testBotTool · test_bot_tool
MCP aracı
testBotTooldış etkili

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği
tool_idyoluuidevetAraç kimliği

Gövde alanları

AdTürZorunluAçıklama
inputobjectevet

Örnek istek

curl -X POST "https://hiboty.com/api/v1/bots/3fa85f64-5717-4562-b3fc-2c963f66afa6/tools/3fa85f64-5717-4562-b3fc-2c963f66afa6/test" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"input":{"urun_kodu":"A-100"}}'

Örnek yanıt (200)

JSON
{
  "data": {
    "success": true,
    "uncertain": true,
    "status": 1,
    "duration_ms": 1,
    "body": "string",
    "truncated": true,
    "model_text": "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.
  • 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.

Yapılandırma sürümlerini listeler

GET/api/v1/bots/{id}/versions

Bot başına son 50 sürüm saklanır. Kapsam: bots:read.

Kapsam
bots:read
SDK metodu
listBotVersions · list_bot_versions
MCP aracı
listBotVersionssalt okunur

Sayfalı

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği
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; eski date-time imleçleri de kabul edilir)

Örnek istek

curl -X GET "https://hiboty.com/api/v1/bots/3fa85f64-5717-4562-b3fc-2c963f66afa6/versions?limit=50" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Örnek yanıt (200)

JSON
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "version": 1,
      "created_at": "2026-11-06T09:00:00.000Z",
      "source": "panel",
      "restored_from_version": 1,
      "readable": true,
      "changes": [
        {
          "field": "string",
          "before": "string",
          "after": "string"
        }
      ],
      "truncated": true,
      "tools_changed": true,
      "sources_changed": true,
      "tool_changes": [
        {
          "name": "Hiboty",
          "change": "eklendi"
        }
      ],
      "source_changes": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "title": "Örnek",
          "change": "eklendi"
        }
      ]
    }
  ],
  "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.
  • 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.

Sürüm farkı ve geri alma önizlemesi

GET/api/v1/bots/{id}/versions/{version_id}

restore_token, önizlenen hâli temsil eder; restoreBotVersion'a aynen verilir. Yönetici değilse restore null döner. Kapsam: bots:read.

Kapsam
bots:read
SDK metodu
getBotVersion · get_bot_version
MCP aracı
getBotVersionsalt okunur

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği
version_idyoluuidevetSürüm kimliği

Örnek istek

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

Örnek yanıt (200)

JSON
{
  "data": {
    "version": 1,
    "changes": [
      {
        "field": "string",
        "before": "string",
        "after": "string"
      }
    ],
    "restore": {
      "available": true,
      "changes": [
        {
          "field": "string",
          "before": "string",
          "after": "string"
        }
      ],
      "skipped_fields": [
        "string"
      ],
      "restore_token": "string",
      "reason": "string",
      "tool_changes": [
        {
          "name": "Hiboty",
          "change": "eklendi"
        }
      ],
      "changed_sources": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "title": "Örnek",
          "change": "eklendi"
        }
      ],
      "tools_need_secret": [
        "string"
      ]
    },
    "tool_changes": [
      {
        "name": "Hiboty",
        "change": "eklendi"
      }
    ],
    "source_changes": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "title": "Örnek",
        "change": "eklendi"
      }
    ]
  }
}

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.

Sürüme geri döner

POST/api/v1/bots/{id}/versions/{version_id}/restore

Yeni sürüm yazar, tarih silinmez; kanal bağlantısı ve durum değişmez. Önizlemeden sonra ayarlar değiştiyse 409 stale_version döner. Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
restoreBotVersion · restore_bot_version
MCP aracı
restoreBotVersiongeri alınamaz

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği
version_idyoluuidevetSürüm kimliği

Gövde alanları

AdTürZorunluAçıklama
restore_tokenstringevet

Örnek istek

curl -X POST "https://hiboty.com/api/v1/bots/3fa85f64-5717-4562-b3fc-2c963f66afa6/versions/3fa85f64-5717-4562-b3fc-2c963f66afa6/restore" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"restore_token":"f3a1c9…"}'

Örnek yanıt (200)

JSON
{
  "data": {
    "new_version": 1,
    "restored_version": 1,
    "pending_approval": true,
    "tools_need_secret": [
      "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.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.stale_version
  • 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.

Kanal vitrin metinleri

GET/api/v1/bots/{id}/profile

Telegram bot adı ve açıklamaları ya da WhatsApp işletme profili; kanaldan canlı okunur. Yönetici yetkisi gerekir. Kapsam: bots:read.

Kapsam
bots:read
SDK metodu
getBotProfile · get_bot_profile
MCP aracı
getBotProfilesalt okunurdış etkili

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği

Örnek istek

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

Örnek yanıt (200)

JSON
{
  "data": {
    "channel": "telegram",
    "tr": {
      "name": "Hiboty",
      "short_description": "string",
      "description": "string"
    },
    "en": {
      "name": "Hiboty",
      "short_description": "string",
      "description": "string"
    },
    "about": "string",
    "description": "string",
    "vertical": "string",
    "website": "https://example.com"
  }
}

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).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.
  • 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.
  • 502Kanal ya da dış servis hatası (channel_error).

Vitrin metinlerini kanala yazar

PUT/api/v1/bots/{id}/profile

Telegram botunda tr ve en, WhatsApp botunda about, vertical (ve isteğe bağlı description, website). Müşteriye görünen kanal profili değişir. Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
updateBotProfile · update_bot_profile
MCP aracı
updateBotProfiledış etkiligeri alınamaz

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği

Gövde alanları

AdTürZorunluAçıklama
trobjecthayır
tr.namestringevetlen ≤ 64
tr.short_descriptionstringevetlen ≤ 120
tr.descriptionstringevetlen ≤ 512
enobjecthayır
en.namestringevetlen ≤ 64
en.short_descriptionstringevetlen ≤ 120
en.descriptionstringevetlen ≤ 512
aboutstringhayırlen ≤ 139
descriptionstringhayırlen ≤ 512
verticalstringhayır
websitestringhayırlen ≤ 256

Örnek istek

curl -X PUT "https://hiboty.com/api/v1/bots/3fa85f64-5717-4562-b3fc-2c963f66afa6/profile" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tr":{"name":"Mağaza Asistanı","short_description":"Sipariş ve kargo soruları","description":"Sipariş, kargo ve iade sorularınızı yanıtlar."},"en":{"name":"Store Assistant","short_description":"Orders and shipping","description":"Answers your order, shipping and return questions."}}'

Örnek yanıt (200)

JSON
{
  "data": {
    "changed": 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.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.
  • 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.
  • 502Kanal ya da dış servis hatası (channel_error).

AI ile vitrin önerisi üretir

POST/api/v1/bots/{id}/profile/suggest

Kanala yazmaz; AI kotasından düşer. Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
suggestBotProfile · suggest_bot_profile
MCP aracı
suggestBotProfile

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği

Örnek istek

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

Örnek yanıt (200)

JSON
{
  "data": {
    "channel": "telegram",
    "tr": {
      "name": "Hiboty",
      "short_description": "string",
      "description": "string"
    },
    "en": {
      "name": "Hiboty",
      "short_description": "string",
      "description": "string"
    },
    "about": "string",
    "description": "string",
    "vertical": "string",
    "website": "https://example.com"
  }
}

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).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.
  • 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.
  • 502Kanal ya da dış servis hatası (channel_error).

AI değerlendirme vakalarını listeler

GET/api/v1/bots/{id}/eval-cases

Kapsam: bots:read.

Kapsam
bots:read
SDK metodu
listBotEvalCases · list_bot_eval_cases
MCP aracı
listBotEvalCasessalt okunur

Sayfalı

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği
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; eski date-time imleçleri de kabul edilir)

Örnek istek

curl -X GET "https://hiboty.com/api/v1/bots/3fa85f64-5717-4562-b3fc-2c963f66afa6/eval-cases?limit=50" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Örnek yanıt (200)

JSON
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "question": "string",
      "must_include": [
        "string"
      ],
      "must_not_include": [
        "string"
      ],
      "expect_handoff": true
    }
  ],
  "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.
  • 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.

Değerlendirme vakası ekler

POST/api/v1/bots/{id}/eval-cases

Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
createBotEvalCase · create_bot_eval_case
MCP aracı
createBotEvalCase

Idempotency-Key destekli

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği
Idempotency-Keybaşlıkstringhayırİsteğe bağlı, 1-255 görünür ASCII karakter. Organizasyon + uç + anahtar başına 24 saat geçerlidir: aynı anahtar ve aynı gövdeyle ilk yanıt aynen döner (Idempotency-Replayed: true), işlem tekrarlanmaz. Farklı gövdede 409 idempotency_conflict; ilk istek sürerken 409 idempotency_in_progress ve Retry-After. 5xx ve 429 yanıtları saklanmaz, aynı anahtarla yeniden denenebilir.len 1–255

Gövde alanları

AdTürZorunluAçıklama
questionstringevetlen 2–1000
must_includestring[]hayıritems ≤ 10
must_not_includestring[]hayıritems ≤ 10
expect_handoffbooleanhayırdefault false

Örnek istek

curl -X POST "https://hiboty.com/api/v1/bots/3fa85f64-5717-4562-b3fc-2c963f66afa6/eval-cases" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Idempotency-Key: order-10482" \
  -H "Content-Type: application/json" \
  -d '{"question":"İade süreniz nedir?","must_include":["14 gün"],"must_not_include":[],"expect_handoff":false}'

Örnek yanıt (201)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "question": "string",
    "must_include": [
      "string"
    ],
    "must_not_include": [
      "string"
    ],
    "expect_handoff": 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).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.
  • 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.

Değerlendirme vakasını günceller

PATCH/api/v1/bots/{id}/eval-cases/{case_id}

Vakanın tamamı gönderilir. Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
updateBotEvalCase · update_bot_eval_case
MCP aracı
updateBotEvalCase

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği
case_idyoluuidevetVaka kimliği

Gövde alanları

AdTürZorunluAçıklama
questionstringevetlen 2–1000
must_includestring[]hayıritems ≤ 10
must_not_includestring[]hayıritems ≤ 10
expect_handoffbooleanhayırdefault false

Örnek istek

curl -X PATCH "https://hiboty.com/api/v1/bots/3fa85f64-5717-4562-b3fc-2c963f66afa6/eval-cases/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"question":"İade süreniz nedir?","must_include":["14 gün"],"must_not_include":["30 gün"],"expect_handoff":false}'

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "question": "string",
    "must_include": [
      "string"
    ],
    "must_not_include": [
      "string"
    ],
    "expect_handoff": 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.

Değerlendirme vakasını siler

DELETE/api/v1/bots/{id}/eval-cases/{case_id}

Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
deleteBotEvalCase · delete_bot_eval_case
MCP aracı
deleteBotEvalCasegeri alınamaz

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği
case_idyoluuidevetVaka kimliği

Örnek istek

curl -X DELETE "https://hiboty.com/api/v1/bots/3fa85f64-5717-4562-b3fc-2c963f66afa6/eval-cases/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.

Değerlendirme çalıştırmalarını listeler

GET/api/v1/bots/{id}/eval-runs

Kapsam: bots:read.

Kapsam
bots:read
SDK metodu
listBotEvalRuns · list_bot_eval_runs
MCP aracı
listBotEvalRunssalt okunur

Sayfalı

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği
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; eski date-time imleçleri de kabul edilir)

Örnek istek

curl -X GET "https://hiboty.com/api/v1/bots/3fa85f64-5717-4562-b3fc-2c963f66afa6/eval-runs?limit=50" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Örnek yanıt (200)

JSON
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "kind": "cases",
      "status": "string",
      "started_at": "string",
      "finished_at": "string",
      "model": "string",
      "summary": {
        "total": 1,
        "passed": 1,
        "failed": 1,
        "errored": 1,
        "not_run": 1
      }
    }
  ],
  "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.
  • 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.

Değerlendirme çalıştırır

POST/api/v1/bots/{id}/eval-runs

kind: cases (vaka seti) ya da security (hazır saldırı listesi). Her yanıt AI kotasından düşer; müşteriye mesaj gitmez, araçlar çağrılmaz. Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
runBotEval · run_bot_eval
MCP aracı
runBotEval

Idempotency-Key destekli

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği
Idempotency-Keybaşlıkstringhayırİsteğe bağlı, 1-255 görünür ASCII karakter. Organizasyon + uç + anahtar başına 24 saat geçerlidir: aynı anahtar ve aynı gövdeyle ilk yanıt aynen döner (Idempotency-Replayed: true), işlem tekrarlanmaz. Farklı gövdede 409 idempotency_conflict; ilk istek sürerken 409 idempotency_in_progress ve Retry-After. 5xx ve 429 yanıtları saklanmaz, aynı anahtarla yeniden denenebilir.len 1–255

Gövde alanları

AdTürZorunluAçıklama
kindenumevetcases | security

Örnek istek

curl -X POST "https://hiboty.com/api/v1/bots/3fa85f64-5717-4562-b3fc-2c963f66afa6/eval-runs" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Idempotency-Key: order-10482" \
  -H "Content-Type: application/json" \
  -d '{"kind":"cases"}'

Örnek yanıt (201)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "summary": {
      "total": 1,
      "passed": 1,
      "failed": 1,
      "errored": 1,
      "not_run": 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.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.
  • 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.

Çalıştırma sonuçları

GET/api/v1/bots/{id}/eval-runs/{run_id}

Kapsam: bots:read.

Kapsam
bots:read
SDK metodu
getBotEvalRun · get_bot_eval_run
MCP aracı
getBotEvalRunsalt okunur

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği
run_idyoluuidevetÇalıştırma kimliği

Örnek istek

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

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "kind": "cases",
    "status": "string",
    "started_at": "string",
    "finished_at": "string",
    "model": "string",
    "summary": {
      "total": 1,
      "passed": 1,
      "failed": 1,
      "errored": 1,
      "not_run": 1
    },
    "comparison": {
      "improved": 1,
      "worsened": 1,
      "added": 1,
      "removed": 1
    },
    "results": [
      {
        "key": "sehir",
        "question": "string",
        "status": "string",
        "reply": "string",
        "handed_off": true,
        "refused": true,
        "reasons": [
          {}
        ],
        "error": "string",
        "change": "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.
  • 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.

Bütün WhatsApp şablonları

GET/api/v1/bots/{id}/whatsapp-templates

Onay bekleyen ve reddedilenler dahil; yalnız onaylılar için listTemplates. Kapsam: bots:read.

Kapsam
bots:read
SDK metodu
listWhatsAppTemplates · list_whats_app_templates
MCP aracı
listWhatsAppTemplatessalt okunurdış etkili

Sayfalı

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği
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; eski date-time imleçleri de kabul edilir)

Örnek istek

curl -X GET "https://hiboty.com/api/v1/bots/3fa85f64-5717-4562-b3fc-2c963f66afa6/whatsapp-templates?limit=50" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Örnek yanıt (200)

JSON
{
  "data": [
    {
      "id": "string",
      "name": "Hiboty",
      "language": "tr",
      "category": "string",
      "status": "string",
      "body": "string",
      "rejected_reason": "string"
    }
  ],
  "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.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.
  • 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.
  • 502Kanal ya da dış servis hatası (channel_error).

WhatsApp şablonu oluşturur

POST/api/v1/bots/{id}/whatsapp-templates

Şablon Meta incelemesine gider. Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
createWhatsAppTemplate · create_whats_app_template
MCP aracı
createWhatsAppTemplatedış etkili

Idempotency-Key destekli

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği
Idempotency-Keybaşlıkstringhayırİsteğe bağlı, 1-255 görünür ASCII karakter. Organizasyon + uç + anahtar başına 24 saat geçerlidir: aynı anahtar ve aynı gövdeyle ilk yanıt aynen döner (Idempotency-Replayed: true), işlem tekrarlanmaz. Farklı gövdede 409 idempotency_conflict; ilk istek sürerken 409 idempotency_in_progress ve Retry-After. 5xx ve 429 yanıtları saklanmaz, aynı anahtarla yeniden denenebilir.len 1–255

Gövde alanları

AdTürZorunluAçıklama
namestringevetlen ≤ 512
categoryenumevetMARKETING | UTILITY
languagestringevet
headerstringhayırlen ≤ 60
bodystringevet{{1}}, {{2}} değişkenleri sıraylalen 1–1024
examplesstring[]hayırHer değişken için örnekitems ≤ 20
footerstringhayırlen ≤ 60
buttonsobject[]hayıritems ≤ 3
buttons[].typeenumhayırquick_reply | url
buttons[].textstringhayırlen ≤ 25
buttons[].urlstringhayırtype=url için https:// adresi

Örnek istek

curl -X POST "https://hiboty.com/api/v1/bots/3fa85f64-5717-4562-b3fc-2c963f66afa6/whatsapp-templates" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Idempotency-Key: order-10482" \
  -H "Content-Type: application/json" \
  -d '{"name":"siparis_kargoda","category":"UTILITY","language":"tr","body":"Merhaba {{1}}, siparişiniz kargoya verildi.","examples":["Ayşe"]}'

Örnek yanıt (201)

JSON
{
  "data": {
    "id": "string",
    "name": "Hiboty",
    "status": "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.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.
  • 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.
  • 502Kanal ya da dış servis hatası (channel_error).

WhatsApp şablonunu siler

DELETE/api/v1/bots/{id}/whatsapp-templates/{name}

Şablon Meta'dan bütün dilleriyle silinir. Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
deleteWhatsAppTemplate · delete_whats_app_template
MCP aracı
deleteWhatsAppTemplatedış etkiligeri alınamaz

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği
nameyolstringevetŞablon adı

Örnek istek

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

Örnek yanıt (200)

JSON
{
  "data": {
    "name": "Hiboty",
    "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).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.
  • 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.
  • 502Kanal ya da dış servis hatası (channel_error).

Beğenilmeyen AI yanıtlarını listeler

GET/api/v1/bots/{id}/ai-feedback

Çözülmemiş yanıtlar, kişinin sorusuyla. Kapsam: bots:read.

Kapsam
bots:read
SDK metodu
listAiFeedback · list_ai_feedback
MCP aracı
listAiFeedbacksalt okunur

Sayfalı

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği
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; eski date-time imleçleri de kabul edilir)

Örnek istek

curl -X GET "https://hiboty.com/api/v1/bots/3fa85f64-5717-4562-b3fc-2c963f66afa6/ai-feedback?limit=50" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Örnek yanıt (200)

JSON
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "question": "string",
      "reply": "string",
      "note": "string",
      "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.
  • 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.

Beğenilmeyen yanıtı çözer

POST/api/v1/bots/{id}/ai-feedback/{message_id}

add_faq: question ve answer ile SSS kaynağı oluşturur; dismiss: yalnız listeden gizler. Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
resolveAiFeedback · resolve_ai_feedback
MCP aracı
resolveAiFeedback

Parametreler

AdTürZorunluAçıklama
idyoluuidevetBot kimliği
message_idyoluuidevetMesaj kimliği

Gövde alanları

AdTürZorunluAçıklama
actionenumevetadd_faq | dismiss
questionstringhayırlen ≤ 500
answerstringhayırlen ≤ 5000

Örnek istek

curl -X POST "https://hiboty.com/api/v1/bots/3fa85f64-5717-4562-b3fc-2c963f66afa6/ai-feedback/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"action":"add_faq","question":"İade süreniz nedir?","answer":"Teslimden itibaren 14 gündür."}'

Örnek yanıt (200)

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

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.

WhatsApp botunun onaylı şablonları

GET/api/v1/templates

Kapsam
read
SDK metodu
listTemplates · list_templates
MCP aracı
listTemplatessalt okunur

Parametreler

AdTürZorunluAçıklama
bot_idsorguuuidevetWhatsApp botu

Örnek istek

curl -X GET "https://hiboty.com/api/v1/templates?bot_id=3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Örnek yanıt (200)

JSON
{
  "data": [
    {
      "name": "Hiboty",
      "language": "tr",
      "category": "string",
      "parameter_count": 1,
      "body": "string",
      "header_parameter": 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).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.
  • 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.
  • 502Kanal ya da dış servis hatası (channel_error).

Telegram webhook'unu yeniden kurar

POST/api/v1/bots/{id}/refresh-webhook

Bot grup ya da kanal olaylarını almıyorsa kullanılır; Telegram'a istek gider. Telegram botu bağlı değilse 409 not_connected, sunucu adresi HTTPS değilse 409 https_required, Telegram reddederse 502 channel_error döner. Yönetici yetkisi gerekir. Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
refreshBotWebhook · refresh_bot_webhook
MCP aracı
refreshBotWebhookdış etkili

Parametreler

AdTürZorunluAçıklama
idyoluuidevetid kimliği

Örnek istek

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

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "webhook_refreshed": 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).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.not_connectedhttps_required
  • 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.
  • 502Kanal ya da dış servis hatası (channel_error).channel_error

Telegram komut menüsünü kur

POST/api/v1/bots/{id}/commands

Telegram botunun komut menüsünü setMyCommands ile kurar. Gövde boşsa varsayılan menü kurulur: /start, /help ve (yalnız küçük İngilizce harf, rakam ve alt çizgi içeriyorsa) devir kelimesi; Türkçe açıklamalar varsayılan, İngilizceler "en" dil kapsamına yazılır. commands verilirse aynı liste iki kapsama yazılır (en fazla 100 komut; komut 1–32 karakter, açıklama 1–256). Menü bağlantıda otomatik kurulur; connect yanıtında warning telegram_commands_failed ise bu uçla yeniden deneyin. Bot bağlı değilse 409 not_connected. Yönetici yetkisi gerekir. Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
setBotCommands · set_bot_commands
MCP aracı
setBotCommandsdış etkili

Parametreler

AdTürZorunluAçıklama
idyoluuidevetid kimliği

Gövde alanları

AdTürZorunluAçıklama
commandsobject[]hayıritems ≤ 100
commands[].commandstringevetlen ≤ 33
commands[].descriptionstringevetlen ≤ 256

Örnek istek

curl -X POST "https://hiboty.com/api/v1/bots/3fa85f64-5717-4562-b3fc-2c963f66afa6/commands" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"commands":[{"command":"start","description":"Start"},{"command":"menu","description":"Menu"}]}'

Örnek yanıt (200)

JSON
{
  "data": {
    "bot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "commands": [
      {
        "command": "string",
        "description": "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.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.not_connected
  • 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.
  • 502Kanal ya da dış servis hatası (channel_error).

Kartla ödeme ayarını getir

GET/api/v1/bots/{id}/payments

Telegram Payments (kartla ödeme) durumu. Sağlayıcı token'ı hiçbir yanıtta dönmez; yalnız provider_token_set ve test_mode döner. Telegram Stars ödemeleri bu ayardan bağımsızdır. Kapsam: bots:read.

Kapsam
bots:read
SDK metodu
getBotPaymentSettings · get_bot_payment_settings
MCP aracı
getBotPaymentSettingssalt okunur

Parametreler

AdTürZorunluAçıklama
idyoluuidevetid kimliği

Örnek istek

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

Örnek yanıt (200)

JSON
{
  "data": {
    "bot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "card_payments_enabled": true,
    "provider_token_set": true,
    "test_mode": true,
    "refund_note": "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.
  • 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.

Kartla ödeme sağlayıcı token'ını kaydet

PUT/api/v1/bots/{id}/payments

BotFather › Payments'tan alınan sağlayıcı token'ını (123:TEST:… ya da 123:LIVE:…) şifreli kaydeder; provider_token null ise token silinir ve kartla ödeme kapanır. Token yalnız biçim olarak denetlenir; geçerliliğini Telegram ilk faturada doğrular. Kaydetmek için bot Telegram'a bağlı olmalıdır (409 not_connected). Kartlı ödemenin iadesi sağlayıcı panelinden yapılır. Yönetici yetkisi gerekir. Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
updateBotPaymentSettings · update_bot_payment_settings
MCP aracı
updateBotPaymentSettings

Parametreler

AdTürZorunluAçıklama
idyoluuidevetid kimliği

Gövde alanları

AdTürZorunluAçıklama
provider_tokenstring | nullevetSağlayıcı token'ı; null token'ı silerlen ≤ 300

Örnek istek

curl -X PUT "https://hiboty.com/api/v1/bots/3fa85f64-5717-4562-b3fc-2c963f66afa6/payments" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"provider_token":"284685063:TEST:…"}'

Örnek yanıt (200)

JSON
{
  "data": {
    "bot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "card_payments_enabled": true,
    "provider_token_set": true,
    "test_mode": true,
    "refund_note": "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.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.not_connected
  • 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.

Onay bekleyen değişiklikleri listeler

GET/api/v1/publish-approvals

Yayın onayı açıkken bekleyen bot yapılandırma, araç ve kaynak değişiklikleri ile Mini App yayınları, yeniden eskiye. Yönetici olmayan için boş liste döner. Kapsam: bots:read.

Kapsam
bots:read
SDK metodu
listPublishApprovals · list_publish_approvals
MCP aracı
listPublishApprovalssalt okunur

Sayfalı

Parametreler

AdTürZorunluAçıklama
bot_idsorguuuidhayırYalnız bu botun değişiklikleri
miniapp_idsorguuuidhayırYalnız bu Mini App'in yayınları
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/publish-approvals?limit=50" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Örnek yanıt (200)

JSON
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": "bot",
      "target_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "target_name": "string",
      "version": 1,
      "action": "yapilandirma",
      "summary": [
        "string"
      ],
      "requested_by": "string",
      "requested_at": "2026-11-06T09:00:00.000Z",
      "own_request": true,
      "api_key_request": true
    }
  ],
  "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.

Bekleyen bot değişikliğini onaylar

POST/api/v1/bots/{id}/versions/{version_id}/approve

Değişiklik onaylayanın yetkisiyle uygulanır. Organizasyonda değerlendirme eşiği varsa son koşunun başarı oranı eşiğin altındaysa 409 threshold döner. Yönetici yetkisi gerekir. Dört göz açıkken değişikliği yapan kişi onaylayamaz (403 four_eyes); API anahtarıyla onay verilemez. Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
approveBotVersion · approve_bot_version
MCP aracı
approveBotVersion

Parametreler

AdTürZorunluAçıklama
idyoluuidevetid kimliği
version_idyoluuidevetversion_id kimliği

Örnek istek

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

Örnek yanıt (200)

JSON
{
  "data": {
    "status": "approved",
    "signing_secret": "string",
    "tools_need_secret": [
      "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.four_eyes
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.threshold
  • 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.

Bekleyen bot değişikliğini reddeder

POST/api/v1/bots/{id}/versions/{version_id}/reject

Değişiklik uygulanmaz; yönetici ya da değişikliği yapan kişi (geri çekme) reddedebilir. Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
rejectBotVersion · reject_bot_version
MCP aracı
rejectBotVersion

Parametreler

AdTürZorunluAçıklama
idyoluuidevetid kimliği
version_idyoluuidevetversion_id kimliği

Örnek istek

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

Örnek yanıt (200)

JSON
{
  "data": {
    "status": "approved",
    "signing_secret": "string",
    "tools_need_secret": [
      "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.
  • 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.

Birden çok botta toplu işlem

POST/api/v1/bots/bulk

Seçilen botları duraklatır (pause), sürdürür (resume) ya da ayarlarını topluca değiştirir (update: ai_enabled, handoff_keyword, voice_transcription). En fazla 100 bot. Her bot ayrı işlenir ve yanıt bot başına sonuç döner (kısmi başarı): erişilemeyen bot not_found, plan sınırı dışındaki bot plan_limit, bağlanmamış bot not_connected nedeniyle atlanır. Ayar değişikliği her bot için sürüm kaydı oluşturur; yayın onayı açıksa her bot için bekleyen değişiklik açılır (pending_approval). Yönetici yetkisi gerekir. Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
bulkBotAction · bulk_bot_action
MCP aracı
bulkBotActiondış etkili

Idempotency-Key destekli

Parametreler

AdTürZorunluAçıklama
Idempotency-Keybaşlıkstringhayırİsteğe bağlı, 1-255 görünür ASCII karakter. Aynı anahtar ve gövdeyle 24 saat içinde ilk yanıt aynen döner; farklı gövdede 409 idempotency_conflict.len 1–255

Gövde alanları

AdTürZorunluAçıklama
actionenumevetpause | resume | update
bot_idsstring[]evetitems 1–100
settingsobjecthayır
settings.ai_enabledbooleanhayır
settings.handoff_keywordstringhayırlen 2–40
settings.voice_transcriptionbooleanhayır

Örnek istek

curl -X POST "https://hiboty.com/api/v1/bots/bulk" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Idempotency-Key: order-10482" \
  -H "Content-Type: application/json" \
  -d '{"action":"update","bot_ids":["6f1c2a4e-1b7d-4c1a-9a51-3f2b8d7e9c10"],"settings":{"ai_enabled":true}}'

Örnek yanıt (200)

JSON
{
  "data": {
    "action": "pause",
    "summary": {
      "total": 1,
      "succeeded": 1,
      "unchanged": 1,
      "pending_approval": 1,
      "skipped": 1
    },
    "results": [
      {
        "bot_id": "string",
        "name": "Hiboty",
        "status": "succeeded",
        "reason": "not_found",
        "version": 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.

Tüm botlarda değerlendirme setini çalıştırır

POST/api/v1/bots/evaluations/run-all

Vakası olan ve plan sınırı içindeki botlar sıraya alınır ve arka planda sırayla çalıştırılır; her vaka bir AI yanıtı üretir ve aylık AI kotasından düşer, müşteriye mesaj gitmez. Önce dry_run: true ile tahmini alın (responses_needed); çalıştırmak için max_responses en az bu sayı olmalıdır, değilse 409 budget_not_confirmed. Kota yetmezse 429 ai_quota_exceeded; organizasyonda sırada ya da çalışan bir değerlendirme varsa 409 run_in_progress. bot_ids verilmezse erişilebilen bütün botlar. Sonuçlar GET /api/v1/bots/evaluations ve botun eval-runs ucundan izlenir. Yönetici yetkisi gerekir. Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
runAllBotEvaluations · run_all_bot_evaluations
MCP aracı
runAllBotEvaluations

Idempotency-Key destekli

Parametreler

AdTürZorunluAçıklama
Idempotency-Keybaşlıkstringhayırİsteğe bağlı, 1-255 görünür ASCII karakter. Aynı anahtar ve gövdeyle 24 saat içinde ilk yanıt aynen döner; farklı gövdede 409 idempotency_conflict.len 1–255

Gövde alanları

AdTürZorunluAçıklama
bot_idsuuid[]hayıritems 1–100
dry_runbooleanhayır
max_responsesintegerhayırOnaylanan en fazla AI yanıtı (bütçe onayı)val ≥ 0

Örnek istek

curl -X POST "https://hiboty.com/api/v1/bots/evaluations/run-all" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Idempotency-Key: order-10482" \
  -H "Content-Type: application/json" \
  -d '{"dry_run":true}'

Örnek yanıt (200)

JSON
{
  "data": {
    "dry_run": true,
    "responses_needed": 1,
    "quota_left": 1,
    "quota_enough": true,
    "key_set": true,
    "in_progress": true,
    "queued": 1,
    "run_ids": [
      "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    ],
    "bots": [
      {
        "bot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "Hiboty",
        "cases": 1,
        "skipped_reason": "no_cases"
      }
    ]
  }
}

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.
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.budget_not_confirmedrun_in_progress
  • 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.ai_quota_exceeded

Filo değerlendirme özeti

GET/api/v1/bots/evaluations

Erişilebilen her bot için son set çalıştırmasının başarı oranı ve önceki tamamlanmış koşuya göre fark (yüzde puanı); genel ortalama, iyileşen ve kötüleşen bot sayısı. Kapsam: bots:read.

Kapsam
bots:read
SDK metodu
getFleetEvaluation · get_fleet_evaluation
MCP aracı
getFleetEvaluationsalt okunur

Örnek istek

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

Örnek yanıt (200)

JSON
{
  "data": {
    "in_progress": true,
    "queued": 1,
    "overview": {
      "bots": 1,
      "evaluated": 1,
      "average_pass_rate": 1,
      "improved": 1,
      "worsened": 1
    },
    "bots": [
      {
        "bot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "Hiboty",
        "channel": "string",
        "cases": 1,
        "status": "queued",
        "last_run": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "finished_at": "string",
          "summary": {
            "total": 1,
            "passed": 1,
            "failed": 1,
            "errored": 1,
            "not_run": 1
          },
          "pass_rate": 1
        },
        "previous_pass_rate": 1,
        "change": 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.

Organizasyon bot şablonlarını listeler

GET/api/v1/bot-templates

Organizasyonun kaydettiği şablonlar (en yeniden eskiye, en fazla 50). Hazır galeri şablonları için GET /api/v1/bots/templates. Başka organizasyonun şablonu görünmez. Yönetici yetkisi gerekir. Kapsam: bots:read.

Kapsam
bots:read
SDK metodu
listOrgBotTemplates · list_org_bot_templates
MCP aracı
listOrgBotTemplatessalt okunur

Örnek istek

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

Örnek yanıt (200)

JSON
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Hiboty",
      "description": "string",
      "channel": "telegram",
      "knowledge_count": 1,
      "tool_count": 1,
      "created_by": "string",
      "created_at": "2026-11-06T09:00:00.000Z",
      "updated_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.

Botu şablon olarak kaydeder

POST/api/v1/bot-templates

Botun persona, karşılama, temsilci kelimesi, AI ayarları, bilgi kaynakları ve AI aracı tanımları şablona yazılır (dışa aktarmayla aynı izin listesi). Şablonda kanal token'ı, App Secret, webhook ve imza sırları, gizli başlıklar, kişiler ve sohbetler bulunmaz. Adres içeren araç ve kaynaklar yanıtta listelenir. Aynı ad organizasyonda tekildir (409). Yönetici yetkisi gerekir. Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
createOrgBotTemplate · create_org_bot_template
MCP aracı
createOrgBotTemplate

Idempotency-Key destekli

Parametreler

AdTürZorunluAçıklama
Idempotency-Keybaşlıkstringhayırİsteğe bağlı, 1-255 görünür ASCII karakter. Aynı anahtar ve gövdeyle 24 saat içinde ilk yanıt aynen döner; farklı gövdede 409 idempotency_conflict.len 1–255

Gövde alanları

AdTürZorunluAçıklama
bot_iduuidevet
namestringevetlen 2–80
descriptionstringhayırlen ≤ 300

Örnek istek

curl -X POST "https://hiboty.com/api/v1/bot-templates" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Idempotency-Key: order-10482" \
  -H "Content-Type: application/json" \
  -d '{"bot_id":"6f1c2a4e-1b7d-4c1a-9a51-3f2b8d7e9c10","name":"Salon bot","description":"Booking and price questions"}'

Örnek yanıt (201)

JSON
{
  "data": {
    "template": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Hiboty",
      "description": "string",
      "channel": "telegram",
      "knowledge_count": 1,
      "tool_count": 1,
      "created_by": "string",
      "created_at": "2026-11-06T09:00:00.000Z",
      "updated_at": "2026-11-06T09:00:00.000Z"
    },
    "urls": [
      {
        "kind": "tool",
        "name": "Hiboty",
        "url": "https://example.com/hook",
        "has_query": 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).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.
  • 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.

Organizasyon şablonunu getirir

GET/api/v1/bot-templates/{id}

Şablonun özeti ve bot dosyası. Şablonda kanal token'ı, App Secret, webhook ve imza sırları, gizli başlıklar, kişiler ve sohbetler bulunmaz. Yönetici yetkisi gerekir. Kapsam: bots:read.

Kapsam
bots:read
SDK metodu
getOrgBotTemplate · get_org_bot_template
MCP aracı
getOrgBotTemplatesalt okunur

Parametreler

AdTürZorunluAçıklama
idyoluuidevetid kimliği

Örnek istek

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

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Hiboty",
    "description": "string",
    "channel": "telegram",
    "knowledge_count": 1,
    "tool_count": 1,
    "created_by": "string",
    "created_at": "2026-11-06T09:00:00.000Z",
    "updated_at": "2026-11-06T09:00:00.000Z",
    "file": {}
  }
}

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.

Şablonun adını ve açıklamasını değiştirir

PATCH/api/v1/bot-templates/{id}

Yalnız ad ve açıklama değişir; içeriği yenilemek için botu yeniden şablon olarak kaydedin. Yönetici yetkisi gerekir. Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
updateOrgBotTemplate · update_org_bot_template
MCP aracı
updateOrgBotTemplate

Parametreler

AdTürZorunluAçıklama
idyoluuidevetid kimliği

Gövde alanları

AdTürZorunluAçıklama
namestringevetlen 2–80
descriptionstringhayırlen ≤ 300

Örnek istek

curl -X PATCH "https://hiboty.com/api/v1/bot-templates/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Salon bot 2026","description":"Booking, price and cancellation questions"}'

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Hiboty",
    "description": "string",
    "channel": "telegram",
    "knowledge_count": 1,
    "tool_count": 1,
    "created_by": "string",
    "created_at": "2026-11-06T09:00:00.000Z",
    "updated_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.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.
  • 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.

Şablonu siler

DELETE/api/v1/bot-templates/{id}

Şablondan oluşturulmuş botlar etkilenmez. Yönetici yetkisi gerekir. Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
deleteOrgBotTemplate · delete_org_bot_template
MCP aracı
deleteOrgBotTemplategeri alınamaz

Parametreler

AdTürZorunluAçıklama
idyoluuidevetid kimliği

Örnek istek

curl -X DELETE "https://hiboty.com/api/v1/bot-templates/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.

Şablondan bot oluşturur

POST/api/v1/bot-templates/{id}/bots

Her zaman yeni taslak bot oluşur: kanal bağlanmaz, AI araçları kapalı gelir ve imza sırları yeniden üretilip yalnız bu yanıtta döner. name ve channel verilmezse şablondaki değerler kullanılır. Plan bot sınırı uygulanır (403 plan_limit). Yönetici yetkisi gerekir. Kapsam: bots:write.

Kapsam
bots:write
SDK metodu
createBotFromOrgTemplate · create_bot_from_org_template
MCP aracı
createBotFromOrgTemplate

Idempotency-Key destekli

Parametreler

AdTürZorunluAçıklama
idyoluuidevetid kimliği
Idempotency-Keybaşlıkstringhayırİsteğe bağlı, 1-255 görünür ASCII karakter. Aynı anahtar ve gövdeyle 24 saat içinde ilk yanıt aynen döner; farklı gövdede 409 idempotency_conflict.len 1–255

Gövde alanları

AdTürZorunluAçıklama
namestringhayırlen 2–80
channelenumhayırtelegram | whatsapp

Örnek istek

curl -X POST "https://hiboty.com/api/v1/bot-templates/3fa85f64-5717-4562-b3fc-2c963f66afa6/bots" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Idempotency-Key: order-10482" \
  -H "Content-Type: application/json" \
  -d '{"name":"Salon Ayse","channel":"whatsapp"}'

Örnek yanıt (201)

JSON
{
  "data": {
    "bot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Hiboty",
    "knowledge_count": 1,
    "tools": [
      {
        "name": "Hiboty",
        "signing_secret": "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.plan_limit
  • 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.

WhatsApp hesaplarını listeler

GET/api/v1/whatsapp-accounts

İşletme portföyü › WhatsApp Business hesabı (WABA) › telefon numarası hiyerarşisi. Aynı WABA'daki numaralar tek hesapta görünür; şablonlar ve Meta faturası hesap düzeyindedir. Erişim anahtarı ve App Secret hiçbir yanıtta dönmez; yalnız access_token_set ve app_secret_set döner. Bot erişimi kısıtlı üye yalnız erişebildiği numaraları ve bu numaraların hesaplarını görür. Kapsam: bots:read.

Kapsam
bots:read
SDK metodu
listWhatsAppAccounts · list_whats_app_accounts
MCP aracı
listWhatsAppAccountssalt 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/whatsapp-accounts?limit=50" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Örnek yanıt (200)

JSON
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "waba_id": "string",
      "business_id": "string",
      "name": "Hiboty",
      "display_name": "string",
      "currency": "USD",
      "timezone_id": "string",
      "embedded": true,
      "status": "bagli",
      "access_token_set": true,
      "app_secret_set": true,
      "last_synced_at": "2026-11-06T09:00:00.000Z",
      "last_error": "string",
      "phone_numbers": [
        {
          "bot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "bot_name": "string",
          "bot_status": "string",
          "display_phone": "string",
          "phone_number_id": "string",
          "quality": "GREEN",
          "messaging_limit": "string",
          "delivery_score": 1,
          "last_webhook_at": "2026-11-06T09:00:00.000Z",
          "last_error": "string"
        }
      ],
      "created_at": "2026-11-06T09:00:00.000Z",
      "updated_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.

WhatsApp hesabını getirir

GET/api/v1/whatsapp-accounts/{id}

Hesap ve numaraları (kalite, mesajlaşma sınırı, teslim puanı). Erişim anahtarı ve App Secret hiçbir yanıtta dönmez; yalnız access_token_set ve app_secret_set döner. Bot erişimi kısıtlı üye yalnız erişebildiği numaraları ve bu numaraların hesaplarını görür. Kapsam: bots:read.

Kapsam
bots:read
SDK metodu
getWhatsAppAccount · get_whats_app_account
MCP aracı
getWhatsAppAccountsalt okunur

Parametreler

AdTürZorunluAçıklama
idyoluuidevetid kimliği

Örnek istek

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

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "waba_id": "string",
    "business_id": "string",
    "name": "Hiboty",
    "display_name": "string",
    "currency": "USD",
    "timezone_id": "string",
    "embedded": true,
    "status": "bagli",
    "access_token_set": true,
    "app_secret_set": true,
    "last_synced_at": "2026-11-06T09:00:00.000Z",
    "last_error": "string",
    "phone_numbers": [
      {
        "bot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "bot_name": "string",
        "bot_status": "string",
        "display_phone": "string",
        "phone_number_id": "string",
        "quality": "GREEN",
        "messaging_limit": "string",
        "delivery_score": 1,
        "last_webhook_at": "2026-11-06T09:00:00.000Z",
        "last_error": "string"
      }
    ],
    "created_at": "2026-11-06T09:00:00.000Z",
    "updated_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.
  • 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.

WhatsApp hesabının şablonlarını listeler

GET/api/v1/whatsapp-accounts/{id}/templates

Meta'daki bütün şablonlar (durum ve ret nedeniyle), hesap (WABA) düzeyinde; hesaba bağlı her numara aynı şablonları kullanır. Hesap bağlı değilse 409 channel_not_configured, Meta hatasında 502. Kapsam: bots:read.

Kapsam
bots:read
SDK metodu
listWhatsAppAccountTemplates · list_whats_app_account_templates
MCP aracı
listWhatsAppAccountTemplatessalt okunur

Sayfalı

Parametreler

AdTürZorunluAçıklama
idyoluuidevetid kimliği
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/whatsapp-accounts/3fa85f64-5717-4562-b3fc-2c963f66afa6/templates?limit=50" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Örnek yanıt (200)

JSON
{
  "data": [
    {
      "id": "string",
      "name": "Hiboty",
      "language": "tr",
      "category": "string",
      "status": "string",
      "body": "string",
      "rejected_reason": "string"
    }
  ],
  "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.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.channel_not_configured
  • 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.
  • 502Kanal ya da dış servis hatası (channel_error).