List custom commands

All custom commands, enabled or not. Requires commands:manage.

GET/commands

Authorization

AuthorizationBearer token (tp_live_... or tpat_...) · headerrequired

A TipPage API key (`tp_live_...`, created in Dashboard → Settings → Developer) or an OAuth 2.0 access token (`tpat_...`, see the OAuth guide). Both carry the same scopes and are accepted on every endpoint.

Responses

200The streamer's custom commands.

commandsCustomCommand[]

Show properties

Array of CustomCommand

namestring

The trigger, without the `!` prefix.

responsestring

What the bot answers. Template variables supported.

descriptionstring | null

Optional viewer-facing blurb shown on the tip page's command list instead of the response. `null` = the page shows a preview of the response with variables rendered as labels (`{urlfetch:}` addresses and `{ai:}` prompts are never shown).

max length 200

listedboolean

Whether the command appears on the tip page's command list. It works in chat either way.

ai_memoryboolean

`{ai:}` conversation memory - when true the character remembers this command's last 15 exchanges (with timestamps, kept until the command is deleted) and reacts to repeats and returning viewers. Only meaningful for responses containing `{ai:}`. Memory is per platform unless `ai_memory_shared`.

ai_memory_sharedboolean

One memory for Twitch and Kick instead of one per platform. Only meaningful with `ai_memory`.

platformsstring[]

Which chat(s) it runs in. Default both. A platform the streamer hasn't connected is simply skipped; the set can't be empty (use `enabled: false` to bench it).

permissionstring

Who can trigger it. `subscriber` includes moderators; `moderator` includes the streamer.

Allowed:everyonesubscribermoderator

cooldown_secondsinteger

min 0 · max 3600

cooldown_typestring

`global` = one shared cooldown for the whole channel; `per_user` = each viewer gets their own.

Allowed:globalper_user

aliasesstring[]

Extra triggers for the same command, also without the `!`.

enabledboolean

created_atstring<date-time>

updated_atstring<date-time>

401Missing or invalid credential (`missing_api_key` / `invalid_api_key`, or `invalid_token` for an expired/revoked OAuth access token).

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. `missing_scope`, `not_in_queue`).

403The key lacks the required scope (`missing_scope`).

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. `missing_scope`, `not_in_queue`).

required_scopestring

429Rate limit exceeded - check the `RateLimit-*` headers.

errorstring

Request

curl -X GET "https://api.tippage.com/v1/commands" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.tippage.com/v1/commands", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.tippage.com/v1/commands",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "commands": [
    {
      "name": "discord",
      "response": "string",
      "description": "string",
      "listed": true,
      "ai_memory": true,
      "ai_memory_shared": true,
      "platforms": [
        "twitch"
      ],
      "permission": "everyone",
      "cooldown_seconds": 3600,
      "cooldown_type": "global",
      "aliases": [
        "string"
      ],
      "enabled": true,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}