Skip to content

v2

Open Chat Studio API version v2.

Build, deploy and monitor chatbots.

LLM Docs

Simplified per-tag references for LLM consumption:

  • Channels — Trigger bot messages or deliver messages directly to users on a channel.
  • Chatbots — List, retrieve and inspect chatbots (v2; formerly 'experiments').
  • Me — Information about the authenticated user and the team the token is scoped to.
  • Usage — Inspect team usage and activity data (message counts, and more).

Endpoints

Channels

Method Path Summary
POST /api/v2/trigger_bot/ Trigger the bot to send a message to the user, or deliver a message directly

Chatbots

Method Path Summary
GET /api/v2/chatbots/ List Chatbots
GET /api/v2/chatbots/{id}/ Retrieve Chatbot
GET /api/v2/chatbots/{id}/inspect/ Inspect Chatbot

Me

Method Path Summary
GET /api/v2/me/ Current User

Usage

Method Path Summary
GET /api/v2/usage/ Usage