API reference

Reference for every public Botyard REST API endpoint, grouped by resource, with request and response schemas rendered from the OpenAPI spec.

The Botyard REST API. All endpoints are versioned under /v1 and authenticate via Authorization: Bearer <api-key>.

Want to try a call instead of reading about it? The interactive API console renders the same surface from the live spec and sends real requests straight from your browser.

addons

api-keys

approvals

audit-events

bot-access

bot-apps

bot-devices

bot-files

bot-templates

bot-tool-domain-settings

bot-tools

bots

centrifugo

challenge

chat

content-blocks

conversations

credentials

device-enrollment

external-chat

file-templates

files

github

health

host-approvals

inbound-emails

inbox

inbox-public

integrations-economic

integrations-github

integrations-oauth

integrations-vending

invitations

managed-credits

mcp-catalog-public

mcp-servers

me

members

notification-preferences

notifications

org-apps

org-settings

organizations

outbound-emails

permissions

plans

push-registrations

questions

realtime

schedules

secret-policies

service-alert

skills

stats

subscriptions

suggestions

tools

usage

user-view

users

vault-entries

vault-input-requests

wallet

workforce-task-files

workforces