Skip to content

Clip command API

Use these actions to set up the !clip chat command and manage the clips it makes.

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 clip_command. Use it to load only this area: https://kickbot.com/api/v1/mcp?areas=clip_command.

A team member needs the Clip command 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: Clip command, Clip pages.

ToolRESTAccess
get_clip_command_settingsGET /clip-command/settingsRead
update_clip_command_settingsPATCH /clip-command/settingsWrite
list_command_clipsGET /clip-command/clipsRead
delete_command_clipDELETE /clip-command/clips/{clip_id}Write

Get the !clip command settings. Read the settings of the !clip chat command: on/off, who can use it, the reply text, and the clip lengths. premium_settings_editable tells you if custom_response and the clip lengths can be changed (premium plan).

GET /api/v1/clip-command/settings

No input fields.

Update the !clip command settings. Change some !clip command settings. Only the fields you send change. Requires a verified account. custom_response, max_clip_length, and default_clip_length are premium settings: a free account that sends a different value gets a premium_required error and nothing is saved.

PATCH /api/v1/clip-command/settings

Needs a read and write key or connection.

FieldTypeRequiredDescription
enabledbooleanNoTurn the !clip command on or off.
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).
custom_responsestring or stringNoPremium only. The chat reply after a clip is made, 15-300 characters. Variables: {user} (who clipped) and {clip_url}. Default ”@{user} {clip_url}”. Empty resets to the default.
max_clip_lengthintegerNoPremium only. Longest clip in seconds a viewer can ask for (for example !clip 90), 10-240. Default 120.
default_clip_lengthintegerNoPremium only. Clip length in seconds when the viewer gives no length, 10-120. Default 30.

List clips made with !clip. List the finished clips viewers made with the !clip command (up to 5 minutes long). Each clip has a public page (url). total_clips counts all finished clips.

GET /api/v1/clip-command/clips
FieldTypeRequiredDescription
sort (query)"newest" or "oldest" or "most_views" or "least_views"NoOrder: newest (default), oldest, most_views, or least_views.
clipper_username (query)stringNoOnly clips made by this Kick username (not case-sensitive).
limit (query)integerNoMax clips to return (1-100, default 50).
offset (query)integerNoNumber of clips to skip (default 0).

Delete a !clip clip. Delete a clip made with !clip: its video files and its public page. Needs the manage_clips permission. This cannot be undone.

DELETE /api/v1/clip-command/clips/{clip_id}

Needs a read and write key or connection. This can delete or replace data, and you may not be able to undo it.

FieldTypeRequiredDescription
clip_id (in the path)stringYesThe clip id, the last part of https://kickbot.com/clip/{clip_id}.