Skip to Content
MosaicMosaicDocs
Tool Reference

CreateBot

Create a bot with a name, stable handle, and optional profile.

Starter documentation. Features and account details may differ from this deployment.

CreateBot

Create a bot with a name, stable handle, and optional profile. Omit teamId for a bot owned by the current user; provide teamId to create a team-owned bot, which requires team administrator or owner permission. Pass channelId when the bot should post to a channel immediately: the current user must be a member of that channel. The response then includes that channel's webhook URL and a credential proposal. The user mints the bearer token from the chat card or bot settings; the secret is never returned in this tool result. Omit channelId to create the bot only, then use ManageBotChannelAccess and IssueBotCredential for later setup.

Parameters

ParameterTypeRequiredDescription
teamIdstringNoTeam id that should own the bot. Omit for a bot owned by the current user.
namestringYesHuman-readable display name for the bot.
handlestringYesStable mention handle using only lowercase ASCII letters, digits, hyphens, and underscores; maximum 64 characters.
descriptionstringNoOptional short description of what the bot does.
avatarUrlstringNoOptional URL for the bot profile picture. Pass the URL of an image already uploaded to Mosaic static files or another reachable image URL.
channelIdstringNoChannel id to grant the new bot access to. Requires current-user channel membership. When set, the tool also returns the channel webhook URL and a credential proposal the user can mint from the chat card.
credentialLabelstringNoOptional label for the credential the user will mint when channelId is set, such as github-webhook. Requires channelId.
credentialExpiresAtstringNoOptional RFC 3339 expiration for the credential the user will mint when channelId is set. Requires channelId.
hasAgentbooleanNoSet true to make this bot an AI agent: mentions and DMs start an agent session. Defaults to false.

On this page