API reference: Chatbots

Chatbots. The agents this token can use.

List the account's chatbots and read one. Every other endpoint starts from a chatbot's ID.

Support agent
SUPPORT
active
Sales assistant
LEAD_GEN
active
Old shop helper
COMMERCE
archived

By , AI EngineerUpdated

List chatbots

GET/chatbots

The chatbots this token may use: all of the account's, or only those the token is limited to. Newest first.

Permission: chatbots:read

Query parameters

limit
integer

Items per page, 1 to 100. Default 20.

cursor
string

meta.pagination.nextCursor from the previous page.

Request
curl https://get-api.simplyboost.io/api/v1/chatbots \
  -H "Authorization: Bearer $SIMPLYBOOST_TOKEN"

Response 200 OK

{
  "ok": true,
  "data": {
    "chatbots": [
      {
        "id": "f45268b2-1980-470d-865d-5048a89aedce",
        "name": "Support agent",
        "status": "active",
        "roles": ["SUPPORT"],
        "language": "auto",
        "createdAt": "2026-06-02T08:15:00+00:00",
        "updatedAt": "2026-10-01T12:40:00+00:00"
      }
    ]
  },
  "meta": {
    "requestId": "req_…",
    "pagination": { "limit": 20, "hasMore": false, "nextCursor": null }
  }
}

Response fields

data.chatbots[].id
string

The chatbot's ID.

data.chatbots[].name
string

Its name.

data.chatbots[].status
string

active or archived.

data.chatbots[].roles
string[]

SUPPORT, LEAD_GEN and/or COMMERCE.

data.chatbots[].language
string

Reply language, or auto to answer in the visitor's language.

data.chatbots[].createdAt
string (date-time)

When it was created.

data.chatbots[].updatedAt
string (date-time)

When its settings last changed.

meta.pagination
object

limit, hasMore (true when there is another page) and nextCursor (null on the last page).

Errors

StatusCodeWhen
400validation_errorlimit or cursor is not valid.

Get a chatbot

GET/chatbots/{chatbotId}

One chatbot, with the same fields as in the list.

Permission: chatbots:read

Path parameters

chatbotId
string (uuid)required

The chatbot. Listed by GET /chatbots.

Request
curl https://get-api.simplyboost.io/api/v1/chatbots/CHATBOT_ID \
  -H "Authorization: Bearer $SIMPLYBOOST_TOKEN"

Response 200 OK

{
  "ok": true,
  "data": { "chatbot": { "id": "f45268b2-…", "name": "Support agent", "status": "active", … } },
  "meta": { "requestId": "req_7c1e4b2a9f0d4e6c8b3a5d7f9e1c2b4a" }
}

Response fields

data.chatbot
object

The chatbot: id, name, status, roles, language, createdAt, updatedAt.

Errors

StatusCodeWhen
404not_foundNo such chatbot, or this token may not see it.

Try SimplyBoost with your own content

Start a 7-day free trial with 100 AI replies. Add your website, install the widget and see how the agent answers your customers. Larger team? Custom plans above 4,000 AI replies come with a dedicated account manager and white-label.

See pricing
  • 7 days, 100 AI replies
  • From €39 a month
  • Hosted in Europe