Skip to content

AI character API

Use these actions to read and change the AI character, the AI that answers viewers in chat.

Each action is a REST endpoint under https://kickbot.com/api/v1 and an MCP tool with the same name. The MCP area name is ai_character. Use it to load only this area: https://kickbot.com/api/v1/mcp?areas=ai_character.

A team member needs the AI character permission in Manage Team. Owners and admins have every permission. Write actions also need a read and write key or connection. See Permissions and security.

How the feature works in the dashboard: AI character.

ToolRESTAccess
get_ai_character_settingsGET /ai-character/settingsRead
update_ai_character_settingsPATCH /ai-character/settingsWrite

Get the AI character settings. Read the AI chat character: on/off, who can use it, the persona, its prompt, the model, and how many AI replies were used in the last 30 days (free plans have a limit).

GET /api/v1/ai-character/settings

No input fields.

Update the AI character settings. Change some AI character settings. Only the fields you send change. Requires a verified account. To use your own persona, set character to “Custom” and send custom_prompt.

PATCH /api/v1/ai-character/settings

Needs a read and write key or connection.

FieldTypeRequiredDescription
enabledbooleanNoTurn the AI character on or off. Viewers talk to it by mentioning @KickBot in chat.
everyone_onlybooleanNoEveryone in chat can use it.
subscriber_onlybooleanNoSubscribers can use it (when everyone_only is false).
vip_onlybooleanNoVIPs can use it (when everyone_only is false).
mod_onlybooleanNoModerators can use it (when everyone_only is false).
characterstringNoThe persona: Default, Darth Vader, Andrew Tate, Donald Trump, Harry Potter, Giga Chad, Catgirl, Pirate Captain, Hype Announcer, Grumpy Grandpa, Medieval Knight, Robot, Mob Boss, Wise Wizard, Cowboy, Custom. A preset also sets its prompt. “Custom” uses custom_prompt.
custom_promptstringNoThe system prompt for the “Custom” character, 15-1000 characters. Used only when character is “Custom”. To switch to “Custom”, send it together with character (or have one saved already).
web_searchbooleanNoLive web search: when chat asks about something recent (news, scores, prices), the bot looks it up on the web first. Premium only; on by default and switched on when the channel gets Premium.
modelstringNoThe AI model id: grok, gpt, claude, gemini, deepseek, kimi (model_options in get_ai_character_settings has the names). Default grok. Choosing another model needs Premium; free channels always use grok.