Developer
Log in

Actions

Chat

6 actions in the Chat group. Each is its own JSON-RPC method, and also runs through action.run.

chat.sendSend a chat message

Sends a message to the chats lit under All in the chat panel (the same "Sends to" row), or to the platforms given. Limited to a few messages a minute per connection.

Keyscope: chat

Parameters

  • texttextrequired

    The message.

    Up to 500 characters

  • platformschoice_listoptional

    Where to send it; the lit chats when left out.

    Any of velora twitch kick youtube owncast

Result

  • failedmap of id → stringalways

    The platforms it didn't, with why.

  • sentarray of stringalways

    The platforms it went to.

Live state

This action has no live state.

Request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "chat.send",
  "params": {
    "text": "<text>"
  }
}

In the SDKs

C#
Task<ChatSendResult> ChatSendAsync(ChatSendParams parameters, CancellationToken cancellationToken = default)
TypeScript
chatSend(params: ChatSendParams): Promise<ChatSendResult>
Python
async def chat_send(self, *, text: str, platforms: list[ChatSendPlatform] | None = None) -> ChatSendResult
JSON Schema
JSON
{
  "params_schema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "additionalProperties": false,
    "properties": {
      "platforms": {
        "description": "Where to send it; the lit chats when left out.",
        "items": {
          "enum": [
            "velora",
            "twitch",
            "kick",
            "youtube",
            "owncast"
          ],
          "type": "string"
        },
        "type": "array",
        "uniqueItems": true
      },
      "text": {
        "description": "The message.",
        "maxLength": 500,
        "type": "string"
      }
    },
    "required": [
      "text"
    ],
    "type": "object"
  },
  "result_schema": {
    "additionalProperties": false,
    "properties": {
      "failed": {
        "additionalProperties": {
          "type": "string"
        },
        "description": "The platforms it didn't, with why.",
        "type": "object"
      },
      "sent": {
        "description": "The platforms it went to.",
        "items": {
          "type": "string"
        },
        "type": "array"
      }
    },
    "required": [
      "sent",
      "failed"
    ],
    "type": "object"
  }
}

chat.modeChat mode

Turns a chat mode on or off: slow mode, followers-only, subscribers-only or emote-only.

Keyscope: chat

Parameters

  • platformchoicerequired

    The platform.

    One of velora

  • modechoicerequired

    Which mode.

    One of slow followers subscribers emotes

  • setchoiceoptional

    On, off, or toggle.

    One of on off toggle · Default "toggle"

  • secondsintegeroptional

    Slow mode's wait between messages (default 30).

    1 to 1800 s

Result

Live state

chat.modes[platform] object

The platform's modes: {slow_seconds, followers_only, subscribers_only, emote_only}. From the chat topic. How to read it.

Request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "chat.mode",
  "params": {
    "platform": "velora",
    "mode": "slow"
  }
}

In the SDKs

C#
Task<ChatModeResult> ChatModeAsync(ChatModeParams parameters, CancellationToken cancellationToken = default)
TypeScript
chatMode(params: ChatModeParams): Promise<ChatModeResult>
Python
async def chat_mode(self, *, mode: ChatModeMode, platform: ChatModePlatform, seconds: int | None = None, set: ChatModeSet | None = None) -> ChatModeResult
JSON Schema
JSON
{
  "params_schema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "additionalProperties": false,
    "properties": {
      "mode": {
        "description": "Which mode.",
        "enum": [
          "slow",
          "followers",
          "subscribers",
          "emotes"
        ],
        "type": "string"
      },
      "platform": {
        "description": "The platform.",
        "enum": [
          "velora"
        ],
        "type": "string"
      },
      "seconds": {
        "description": "Slow mode's wait between messages (default 30).",
        "maximum": 1800,
        "minimum": 1,
        "type": "integer"
      },
      "set": {
        "default": "toggle",
        "description": "On, off, or toggle.",
        "enum": [
          "on",
          "off",
          "toggle"
        ],
        "type": "string"
      }
    },
    "required": [
      "platform",
      "mode"
    ],
    "type": "object"
  },
  "result_schema": {
    "additionalProperties": false,
    "properties": {
      "modes": {
        "additionalProperties": false,
        "properties": {
          "emote_only": {
            "type": "boolean"
          },
          "followers_only": {
            "type": "boolean"
          },
          "slow_seconds": {
            "description": "Slow mode's wait between messages; null while slow mode is off.",
            "type": [
              "integer",
              "null"
            ]
          },
          "subscribers_only": {
            "type": "boolean"
          }
        },
        "required": [
          "slow_seconds",
          "followers_only",
          "subscribers_only",
          "emote_only"
        ],
        "title": "ChatModes",
        "type": "object"
      },
      "platform": {
        "type": "string"
      }
    },
    "required": [
      "platform",
      "modes"
    ],
    "type": "object"
  }
}

chat.moderateBan or time out

Bans, unbans or times out a person in a platform's chat. Every parameter is explicit: there are no defaults.

Keydestructivescope: chat

Parameters

  • platformchoicerequired

    The platform.

    One of velora twitch kick youtube

  • actionchoicerequired

    What to do.

    One of ban unban timeout

  • usertextrequired

    Their login name on that platform.

    Up to 100 characters

  • secondsintegeroptional

    A timeout's length (required for timeout).

    1 to 1209600 s

Result

  • actionModerationAction (string)always

    One of "ban" "unban" "timeout"

  • platformstringalways
  • userstringalways

    Their login name, as sent.

Live state

This action has no live state.

Request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "chat.moderate",
  "params": {
    "platform": "velora",
    "action": "ban",
    "user": "<text>"
  }
}

In the SDKs

C#
Task<ChatModerateResult> ChatModerateAsync(ChatModerateParams parameters, CancellationToken cancellationToken = default)
TypeScript
chatModerate(params: ChatModerateParams): Promise<ChatModerateResult>
Python
async def chat_moderate(self, *, action: ModerationAction, platform: ChatModeratePlatform, user: str, seconds: int | None = None) -> ChatModerateResult
JSON Schema
JSON
{
  "params_schema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "additionalProperties": false,
    "properties": {
      "action": {
        "description": "What to do.",
        "enum": [
          "ban",
          "unban",
          "timeout"
        ],
        "type": "string"
      },
      "platform": {
        "description": "The platform.",
        "enum": [
          "velora",
          "twitch",
          "kick",
          "youtube"
        ],
        "type": "string"
      },
      "seconds": {
        "description": "A timeout's length (required for timeout).",
        "maximum": 1209600,
        "minimum": 1,
        "type": "integer"
      },
      "user": {
        "description": "Their login name on that platform.",
        "maxLength": 100,
        "type": "string"
      }
    },
    "required": [
      "platform",
      "action",
      "user"
    ],
    "type": "object"
  },
  "result_schema": {
    "additionalProperties": false,
    "properties": {
      "action": {
        "enum": [
          "ban",
          "unban",
          "timeout"
        ],
        "title": "ModerationAction",
        "type": "string"
      },
      "platform": {
        "type": "string"
      },
      "user": {
        "description": "Their login name, as sent.",
        "type": "string"
      }
    },
    "required": [
      "platform",
      "action",
      "user"
    ],
    "type": "object"
  }
}

chat.emotesEmote picker

The emote picker's tabs as Studio's picker builds them (SPEC-08 §9): one per connected platform that can send and has emotes, each with its look (style), its sections in that platform's order, every emote's pictures, lock state and the text a pick inserts. With query, the search hits too. For a remote's composer.

Keyscope: chat

Parameters

  • platformschoice_listoptional

    The tabs to build; every connected platform when left out.

    Any of velora twitch kick youtube owncast

  • querytextoptional

    Search these tabs, ranked as the picker ranks (exact, starts with, a word starting with, anywhere).

    Up to 100 characters

  • prefsjsonoptional

    The remote's own recents and favorites ({"platforms":{"twitch":{"recent":[emote…],"favourites":[emote…]}}}), so its tabs start with them.

Result

  • hitsarray of EmoteHitoptional

    With query: the matches, best first, the tabs' order kept within a rank.

    Fields of hits
    • emoteintegeralways

      Index into that section's emotes.

    • platformstringalways
    • sectionintegeralways

      Index into that tab's sections.

  • platformsarray of stringalways

    Every connected platform with a picker, Velora first, then by name.

  • tabsarray of EmoteTabalways
    Fields of tabs
    • allEmoteAllDiscoptional

      Velora's ALL disc, first on its rail and open by default (velora.tv's picker): the discs filter the grid, ALL showing these sections in order under their headers and any other disc only its own section, with no header. Absent: the rail scrolls one long grid.

      Fields of all
      • accentstringalways

        Its ring, #RRGGBB.

      • sectionsarray of stringalways

        The keys of the sections ALL shows (not the emoji or 7TV).

    • countintegeralways

      How many emotes it has, each once, for the tab's label.

    • needs_sign_inbooleanalways

      Twitch: this sign-in can't list the person's own emotes yet.

    • notesarray of stringalways

      Quiet notes under the grid (a service that couldn't be reached).

    • platformstringalways
    • sectionsarray of EmoteSectionalways
      Fields of sections
      • accentstringoptional

        Its rail disc's ring, #RRGGBB: on Velora a creator's set wears that creator's profile accent (Velora gold, #D4AF37, without one) and Velora's own sets velora.tv's colors. Absent: a quiet ring.

      • emotesarray of PickEmotealways
        Fields of emotes
        • animatedbooleanalways
        • codestringalways

          Its name, bare (no colons).

        • detailstringalways

          Where it's from, for the long-press card ("7TV · Channel", "Subscriber").

        • glyphstringoptional

          A unicode emoji, drawn with the system's emoji font.

        • idstringalways

          Its id with its service (a unicode emoji: the emoji).

        • insertstringalways

          What a pick puts in the composer (Velora's 7TV as :code:, Kick's as [emote:ID:NAME], Owncast's as :name:, the rest bare).

        • lockedstringoptional

          Why it can't be used, in its platform's words; absent when usable.

        • platformstringalways

          The tab it's picked from.

        • sourcestringalways

          Whose emote: velora, 7tv, bttv, ffz, twitch, kick, owncast or emoji.

        • spanbooleanalways

          The composer remembers it as an emote (every platform emote; not a unicode emoji), so each platform's copy can leave it out where it doesn't show.

        • urlsarray of stringalways

          Its 1x, 2x and 4x pictures (fewer when the service has fewer; none for a unicode emoji).

        • zero_widthbooleanalways

          Drawn on top of the emote before it.

      • iconone ofalways
        Fields of icon
        • When t: "mark"

          • platformstringalways

            A platform's mark.

          • t = "mark"always
        • When t: "service"

          • servicestringalways

            An emote service's mark: 7tv, bttv or ffz.

          • t = "service"always
        • When t: "image"

          • t = "image"always
          • urlstringalways

            A channel's avatar, or an emote standing for its set.

        • When t: "glyph"

          • t = "glyph"always
          • textstringalways

            A unicode emoji.

        • When t: "symbol"

          • namestringalways

            A Lucide icon's name (star, clock, smile…).

          • t = "symbol"always
        • When t: "initial"

          • t = "initial"always
          • textstringalways

            A name's first letter, when there's no picture.

      • keystringalways

        Stable within the tab (the section rail, a scroll position).

      • kindstringalways

        favourites, recent, channel, subscription, follower, global, emoji, thirdparty, collection or raid.

      • lockedbooleanalways

        Every emote in it is locked (its header says why).

      • notestringoptional
      • titlestringalways
    • styleEmotePickerStylealways
      Fields of style
      • accentstringalways

        The platform's own color (tab pill, underline, focus, rail markers), never a background.

      • cellintegeralways

        One cell, px.

      • emoteintegeralways

        The picture inside it, px.

      • gapintegeralways

        Between cells, px.

      • headerstringalways

        Section headers: caps (Velora), bold (avatar and name: Twitch, Kick) or plain (YouTube).

      • lockstringalways

        How a locked emote looks: badge (Velora, Twitch) or veil (Kick).

      • lookstringalways

        Which platform's look: velora, twitch, kick, youtube or owncast.

      • radiusintegeralways

        The hover and focus shape's corner radius (cell / 2 is round).

      • railstringalways

        The section rail: left (Twitch), top (Kick, YouTube), discs (Velora) or none.

      • tilesbooleanalways

        Cells drawn as tiles with a border at rest (Velora).

Live state

This action has no live state.

Request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "chat.emotes"
}

In the SDKs

C#
Task<ChatEmotesResult> ChatEmotesAsync(CancellationToken cancellationToken = default)
Python
async def chat_emotes(self, *, platforms: list[ChatEmotesPlatform] | None = None, prefs: Any | None = None, query: str | None = None) -> ChatEmotesResult
JSON Schema
JSON
{
  "params_schema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "additionalProperties": false,
    "properties": {
      "platforms": {
        "description": "The tabs to build; every connected platform when left out.",
        "items": {
          "enum": [
            "velora",
            "twitch",
            "kick",
            "youtube",
            "owncast"
          ],
          "type": "string"
        },
        "type": "array",
        "uniqueItems": true
      },
      "prefs": {
        "description": "The remote's own recents and favorites ({\"platforms\":{\"twitch\":{\"recent\":[emote…],\"favourites\":[emote…]}}}), so its tabs start with them."
      },
      "query": {
        "description": "Search these tabs, ranked as the picker ranks (exact, starts with, a word starting with, anywhere).",
        "maxLength": 100,
        "type": "string"
      }
    },
    "required": [],
    "type": "object"
  },
  "result_schema": {
    "additionalProperties": false,
    "properties": {
      "hits": {
        "description": "With query: the matches, best first, the tabs' order kept within a rank.",
        "items": {
          "additionalProperties": false,
          "properties": {
            "emote": {
              "description": "Index into that section's emotes.",
              "type": "integer"
            },
            "platform": {
              "type": "string"
            },
            "section": {
              "description": "Index into that tab's sections.",
              "type": "integer"
            }
          },
          "required": [
            "platform",
            "section",
            "emote"
          ],
          "title": "EmoteHit",
          "type": "object"
        },
        "type": "array"
      },
      "platforms": {
        "description": "Every connected platform with a picker, Velora first, then by name.",
        "items": {
          "type": "string"
        },
        "type": "array"
      },
      "tabs": {
        "items": {
          "additionalProperties": false,
          "properties": {
            "all": {
              "additionalProperties": false,
              "description": "Velora's ALL disc, first on its rail and open by default (velora.tv's picker): the discs filter the grid, ALL showing these sections in order under their headers and any other disc only its own section, with no header. Absent: the rail scrolls one long grid.",
              "properties": {
                "accent": {
                  "description": "Its ring, #RRGGBB.",
                  "type": "string"
                },
                "sections": {
                  "description": "The keys of the sections ALL shows (not the emoji or 7TV).",
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                }
              },
              "required": [
                "sections",
                "accent"
              ],
              "title": "EmoteAllDisc",
              "type": "object"
            },
            "count": {
              "description": "How many emotes it has, each once, for the tab's label.",
              "type": "integer"
            },
            "needs_sign_in": {
              "description": "Twitch: this sign-in can't list the person's own emotes yet.",
              "type": "boolean"
            },
            "notes": {
              "description": "Quiet notes under the grid (a service that couldn't be reached).",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "platform": {
              "type": "string"
            },
            "sections": {
              "items": {
                "additionalProperties": false,
                "properties": {
                  "accent": {
                    "description": "Its rail disc's ring, #RRGGBB: on Velora a creator's set wears that creator's profile accent (Velora gold, #D4AF37, without one) and Velora's own sets velora.tv's colors. Absent: a quiet ring.",
                    "type": "string"
                  },
                  "emotes": {
                    "items": {
                      "additionalProperties": false,
                      "properties": {
                        "animated": {
                          "type": "boolean"
                        },
                        "code": {
                          "description": "Its name, bare (no colons).",
                          "type": "string"
                        },
                        "detail": {
                          "description": "Where it's from, for the long-press card (\"7TV · Channel\", \"Subscriber\").",
                          "type": "string"
                        },
                        "glyph": {
                          "description": "A unicode emoji, drawn with the system's emoji font.",
                          "type": "string"
                        },
                        "id": {
                          "description": "Its id with its service (a unicode emoji: the emoji).",
                          "type": "string"
                        },
                        "insert": {
                          "description": "What a pick puts in the composer (Velora's 7TV as :code:, Kick's as [emote:ID:NAME], Owncast's as :name:, the rest bare).",
                          "type": "string"
                        },
                        "locked": {
                          "description": "Why it can't be used, in its platform's words; absent when usable.",
                          "type": "string"
                        },
                        "platform": {
                          "description": "The tab it's picked from.",
                          "type": "string"
                        },
                        "source": {
                          "description": "Whose emote: velora, 7tv, bttv, ffz, twitch, kick, owncast or emoji.",
                          "type": "string"
                        },
                        "span": {
                          "description": "The composer remembers it as an emote (every platform emote; not a unicode emoji), so each platform's copy can leave it out where it doesn't show.",
                          "type": "boolean"
                        },
                        "urls": {
                          "description": "Its 1x, 2x and 4x pictures (fewer when the service has fewer; none for a unicode emoji).",
                          "items": {
                            "type": "string"
                          },
                          "type": "array"
                        },
                        "zero_width": {
                          "description": "Drawn on top of the emote before it.",
                          "type": "boolean"
                        }
                      },
                      "required": [
                        "code",
                        "insert",
                        "id",
                        "source",
                        "platform",
                        "urls",
                        "animated",
                        "zero_width",
                        "detail",
                        "span"
                      ],
                      "title": "PickEmote",
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "icon": {
                    "oneOf": [
                      {
                        "additionalProperties": false,
                        "properties": {
                          "platform": {
                            "description": "A platform's mark.",
                            "type": "string"
                          },
                          "t": {
                            "const": "mark"
                          }
                        },
                        "required": [
                          "t",
                          "platform"
                        ],
                        "type": "object"
                      },
                      {
                        "additionalProperties": false,
                        "properties": {
                          "service": {
                            "description": "An emote service's mark: 7tv, bttv or ffz.",
                            "type": "string"
                          },
                          "t": {
                            "const": "service"
                          }
                        },
                        "required": [
                          "t",
                          "service"
                        ],
                        "type": "object"
                      },
                      {
                        "additionalProperties": false,
                        "properties": {
                          "t": {
                            "const": "image"
                          },
                          "url": {
                            "description": "A channel's avatar, or an emote standing for its set.",
                            "type": "string"
                          }
                        },
                        "required": [
                          "t",
                          "url"
                        ],
                        "type": "object"
                      },
                      {
                        "additionalProperties": false,
                        "properties": {
                          "t": {
                            "const": "glyph"
                          },
                          "text": {
                            "description": "A unicode emoji.",
                            "type": "string"
                          }
                        },
                        "required": [
                          "t",
                          "text"
                        ],
                        "type": "object"
                      },
                      {
                        "additionalProperties": false,
                        "properties": {
                          "name": {
                            "description": "A Lucide icon's name (star, clock, smile…).",
                            "type": "string"
                          },
                          "t": {
                            "const": "symbol"
                          }
                        },
                        "required": [
                          "t",
                          "name"
                        ],
                        "type": "object"
                      },
                      {
                        "additionalProperties": false,
                        "properties": {
                          "t": {
                            "const": "initial"
                          },
                          "text": {
                            "description": "A name's first letter, when there's no picture.",
                            "type": "string"
                          }
                        },
                        "required": [
                          "t",
                          "text"
                        ],
                        "type": "object"
                      }
                    ],
                    "title": "EmoteSectionIcon"
                  },
                  "key": {
                    "description": "Stable within the tab (the section rail, a scroll position).",
                    "type": "string"
                  },
                  "kind": {
                    "description": "favourites, recent, channel, subscription, follower, global, emoji, thirdparty, collection or raid.",
                    "type": "string"
                  },
                  "locked": {
                    "description": "Every emote in it is locked (its header says why).",
                    "type": "boolean"
                  },
                  "note": {
                    "type": "string"
                  },
                  "title": {
                    "type": "string"
                  }
                },
                "required": [
                  "key",
                  "title",
                  "icon",
                  "kind",
                  "locked",
                  "emotes"
                ],
                "title": "EmoteSection",
                "type": "object"
              },
              "type": "array"
            },
            "style": {
              "additionalProperties": false,
              "properties": {
                "accent": {
                  "description": "The platform's own color (tab pill, underline, focus, rail markers), never a background.",
                  "type": "string"
                },
                "cell": {
                  "description": "One cell, px.",
                  "type": "integer"
                },
                "emote": {
                  "description": "The picture inside it, px.",
                  "type": "integer"
                },
                "gap": {
                  "description": "Between cells, px.",
                  "type": "integer"
                },
                "header": {
                  "description": "Section headers: caps (Velora), bold (avatar and name: Twitch, Kick) or plain (YouTube).",
                  "type": "string"
                },
                "lock": {
                  "description": "How a locked emote looks: badge (Velora, Twitch) or veil (Kick).",
                  "type": "string"
                },
                "look": {
                  "description": "Which platform's look: velora, twitch, kick, youtube or owncast.",
                  "type": "string"
                },
                "radius": {
                  "description": "The hover and focus shape's corner radius (cell / 2 is round).",
                  "type": "integer"
                },
                "rail": {
                  "description": "The section rail: left (Twitch), top (Kick, YouTube), discs (Velora) or none.",
                  "type": "string"
                },
                "tiles": {
                  "description": "Cells drawn as tiles with a border at rest (Velora).",
                  "type": "boolean"
                }
              },
              "required": [
                "look",
                "accent",
                "cell",
                "emote",
                "gap",
                "radius",
                "tiles",
                "header",
                "rail",
                "lock"
              ],
              "title": "EmotePickerStyle",
              "type": "object"
            }
          },
          "required": [
            "platform",
            "style",
            "sections",
            "notes",
            "needs_sign_in",
            "count"
          ],
          "title": "EmoteTab",
          "type": "object"
        },
        "type": "array"
      }
    },
    "required": [
      "platforms",
      "tabs"
    ],
    "type": "object"
  }
}

chat.deleteDelete a message

Deletes one chat message for everyone, as the Chat dock's Delete message does. The message is a chat row's native_id (from the chat topic's events or the chat view).

Keydestructivescope: chat

Parameters

  • platformchoicerequired

    The platform.

    One of velora twitch kick youtube owncast

  • messagetextrequired

    The message's id on that platform (a chat row's native_id).

    Up to 200 characters

Result

  • deletedbooleanalways
  • messagestringalways

    The message's id, as sent.

  • platformstringalways

Live state

This action has no live state.

Request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "chat.delete",
  "params": {
    "platform": "velora",
    "message": "<text>"
  }
}

In the SDKs

C#
Task<ChatDeleteResult> ChatDeleteAsync(ChatDeleteParams parameters, CancellationToken cancellationToken = default)
TypeScript
chatDelete(params: ChatDeleteParams): Promise<ChatDeleteResult>
Python
async def chat_delete(self, *, message: str, platform: ChatDeletePlatform) -> ChatDeleteResult
JSON Schema
JSON
{
  "params_schema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "additionalProperties": false,
    "properties": {
      "message": {
        "description": "The message's id on that platform (a chat row's native_id).",
        "maxLength": 200,
        "type": "string"
      },
      "platform": {
        "description": "The platform.",
        "enum": [
          "velora",
          "twitch",
          "kick",
          "youtube",
          "owncast"
        ],
        "type": "string"
      }
    },
    "required": [
      "platform",
      "message"
    ],
    "type": "object"
  },
  "result_schema": {
    "additionalProperties": false,
    "properties": {
      "deleted": {
        "type": "boolean"
      },
      "message": {
        "description": "The message's id, as sent.",
        "type": "string"
      },
      "platform": {
        "type": "string"
      }
    },
    "required": [
      "platform",
      "message",
      "deleted"
    ],
    "type": "object"
  }
}

chat.clearClear chat

Clears a platform's chat for everyone. Viewers see every message go, so it needs "confirm": true; a key should also ask for a long press.

Keydestructivescope: chat

Parameters

  • platformchoicerequired

    The platform.

    One of velora twitch

  • confirmboolrequired

    Must be true.

    Must be true

Result

  • clearedbooleanalways
  • platformstringalways

Live state

This action has no live state.

Request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "chat.clear",
  "params": {
    "platform": "velora",
    "confirm": true
  }
}

In the SDKs

C#
Task<ChatClearResult> ChatClearAsync(ChatClearParams parameters, CancellationToken cancellationToken = default)
TypeScript
chatClear(params: ChatClearParams): Promise<ChatClearResult>
Python
async def chat_clear(self, *, confirm: bool, platform: ChatClearPlatform) -> ChatClearResult
JSON Schema
JSON
{
  "params_schema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "additionalProperties": false,
    "properties": {
      "confirm": {
        "const": true,
        "description": "Must be true.",
        "type": "boolean"
      },
      "platform": {
        "description": "The platform.",
        "enum": [
          "velora",
          "twitch"
        ],
        "type": "string"
      }
    },
    "required": [
      "platform",
      "confirm"
    ],
    "type": "object"
  },
  "result_schema": {
    "additionalProperties": false,
    "properties": {
      "cleared": {
        "type": "boolean"
      },
      "platform": {
        "type": "string"
      }
    },
    "required": [
      "platform",
      "cleared"
    ],
    "type": "object"
  }
}

to open · ↑ ↓ to move · Esc to close