Apps

Update AI bot settings for an app (v2, tenant actor)

Auth: Tenant Actor

Same operation as /v2/bot, but with explicit app targeting. Supports User JWT and B2B Server JWT.

put/v2/apps/{appId}/bot

Request

  • Base URL: https://api.chat.ethora.com
  • URL: https://api.chat.ethora.com/v2/apps/{appId}/bot
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

appIdstring required

Target App ID. Must be an app the calling actor owns or has been delegated access to.

Request body

status'on' | 'off'

on to enable the AI bot for this app, off to disable. When off, no LLM calls are made and the bot user does not respond in chats.

trigger'any_message' | '/bot'

When the bot replies. any_message (every message in joined rooms) or /bot (only when a message starts with /bot).

promptstring

System prompt prepended to the LLM context on every reply. Shapes the bot's persona and behavior; supports markdown.

greetingMessagestring

Optional message the bot posts when first added to a room or when a new user joins.

chatIdstring

Optional chat ID the bot is anchored to. When set, the bot only responds in this room rather than every room it's been added to.

isRAGboolean

If true, the bot augments LLM context with the app's RAG sources (uploaded docs + crawled sites) at reply time.

botFirstNamestring

Given name for the bot user. Shown as the message sender in the chat-component.

botLastNamestring

Family name for the bot user. Shown alongside botFirstName.

savedAgentIdstring
ragTagsstring[]
llmProviderstring
llmModelstring
widgetPublicEnabledboolean
widgetPublicUrlstring
botDisplayNamestring

Empty means unchanged.

botAvatarUrlstring
defaultBotInstanceIdstring

Which BotInstance answers the website widget. Must be one of this App's BotInstances (422 otherwise); "" clears it.

Response

ok

Changes

No recorded changes to this operation across all 1 revision of this API.