Get bot

• bot_idstringrequired

• 200OKapplication/json

  BotRead

  • allowed_domainsarray of string | nullrequired
  • contact_fields_configarray of anyrequired
  • created_atstring (date-time)required
  • descriptionstring | nullrequired
  • directory_configobject | nullrequired
  • fallback_messagestring | nullrequired
  • handoff_enabledbooleanrequired
  • idstringrequired
  • indexed_chunk_countintegerrequired
  • is_publicbooleanrequired
  • languagestringrequired
  • last_errorstring | nullrequired
  • lead_capture_configobject | nullrequired
  • llm_providerLLMProviderTyperequired

    platform uses the credentials this deployment is configured with; byok ("bring your own key") uses the tenant's own Anthropic key; custom posts to an owner-supplied OpenAI-compatible endpoint.

    One of: platform, byok, custom

  • max_tokensintegerrequired
  • modelstring | nullrequired
  • monthly_message_capinteger | nullrequired
  • namestringrequired
  • org_idstringrequired
  • public_keystringrequired
  • rate_limit_per_minuteintegerrequired
  • starter_questionsarray of stringrequired
  • statusBotStatusrequired

    One of: draft, active, paused, archived

  • strict_kb_modebooleanrequired
  • system_promptstringrequired
  • temperaturenumberrequired
  • thinking_enabledbooleanrequired
  • total_conversationsintegerrequired
  • total_messagesintegerrequired
  • updated_atstring (date-time)required
  • welcome_messagestring | nullrequired
  • widget_themeobjectrequired
  • custom_endpoint_configobject | null
  • has_api_keyboolean

    Default: false

  ›5 response headers

  RateLimit-Limit

  Requests permitted in the current window.

  RateLimit-Remaining

  Requests left in the current window. Back off before it reaches 0.

  RateLimit-Reset

  Seconds until the current window resets.

  X-API-Version

  The dated version of the API contract that served this response, e.g. 2026-09-03. Pin against it; it changes only when a response shape changes incompatibly.

  X-Request-ID

  Quote this in a support request to identify the call.

• 422Validation error

  The shared error envelope, served as application/problem+json with error.code set to validation_error. Its details name each field that failed and why.

curl "https://api.integrable.cloud/api/bots/$BOT_ID" \
  -H "Authorization: Bearer $INTEGRABLE_API_KEY"

Set INTEGRABLE_API_KEY and the path variables first. The same call from the TypeScript or Python SDK takes the same fields.

{
  "allowed_domains": [
    "https://example.com"
  ],
  "contact_fields_config": [
    "string"
  ],
  "created_at": "2026-09-03T09:30:00Z",
  "custom_endpoint_config": {},
  "description": "string",
  "directory_config": {},
  "fallback_message": "string",
  "handoff_enabled": true,
  "has_api_key": false,
  "id": "01a0652b-3713-7ea1-a6c9-2e895389ec34",
  "indexed_chunk_count": 20,
  "is_public": true,
  "language": "string",
  "last_error": "string",
  "lead_capture_config": {},
  "llm_provider": "platform",
  "max_tokens": 0,
  "model": "string",
  "monthly_message_cap": 0,
  "name": "string",
  "org_id": "01a0652b-3713-7ea1-a6c9-2e895389ec34",
  "public_key": "string",
  "rate_limit_per_minute": 20,
  "starter_questions": [
    "string"
  ],
  "status": "draft",
  "strict_kb_mode": true,
  "system_prompt": "string",
  "temperature": 0,
  "thinking_enabled": true,
  "total_conversations": 0,
  "total_messages": 0,
  "updated_at": "2026-09-03T09:30:00Z",
  "welcome_message": "string",
  "widget_theme": {}
}

Generated from the schema above — the shape is exact, the values are placeholders.

• get/api/botsList bots
• post/api/botsCreate bot
• post/api/bots/generateGenerate bot
• get/api/bots/modelsAvailable models
• post/api/bots/onboarding/rehearseRehearse blueprint
• post/api/bots/onboarding/scanScan website
• post/api/bots/onboarding/variantsGenerate variants
• patch/api/bots/{bot_id}Update bot
• delete/api/bots/{bot_id}Delete bot
• post/api/bots/{bot_id}/duplicateDuplicate bot
• get/api/bots/{bot_id}/embedGet embed
• get/api/bots/{bot_id}/funnelGet funnel
• post/api/bots/{bot_id}/rotate-keyRotate key
• post/api/bots/{bot_id}/suggest-improvementsSuggest improvements
• post/api/bots/{bot_id}/testTest message
• post/api/bots/{bot_id}/theme/avatarUpload avatar
• delete/api/bots/{bot_id}/theme/avatarDelete avatar
• post/api/bots/{bot_id}/theme/generateGenerate theme
• get/api/bots/{bot_id}/versionsList versions
• post/api/bots/{bot_id}/versions/{version}/restoreRestore version