Botpress

Botpress is an open-source conversational AI platform for building, deploying, and managing chatbots with a visual flow editor and cloud hosting. Botpress Cloud exposes a REST API plus a Chat API for sending messages to deployed bots. Self-hosted Botpress remains open-source.

2 APIs 0 Features

AIConversationalChatOpen SourceBot BuilderLLM

APIs

Botpress Cloud Management API

REST API for managing bots, integrations, conversations, users, and analytics on Botpress Cloud. Authentication via personal access tokens or workspace API keys.

Botpress Chat API

Webhook-based REST API for sending and receiving chat messages with deployed Botpress bots. Endpoint pattern is https://chat.botpress.cloud/{webhookUrl}/messages.

Collections

Botpress Cloud API

OPEN

Pricing Plans

Botpress Plans Pricing

6 plans

PLANS

Rate Limits

Botpress Rate Limits

7 limits

RATE LIMITS

FinOps

Botpress Finops

FINOPS

Resources

Sources

opencollection: 1.0.0
info:
  name: Botpress Cloud API
  version: 1.0.0
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Conversations
    type: folder
  items:
  - info:
      name: List conversations
      type: http
    http:
      method: GET
      url: https://api.botpress.com/v1/chat/conversations
    docs: List conversations
  - info:
      name: Create a new conversation
      type: http
    http:
      method: POST
      url: https://api.botpress.com/v1/chat/conversations
    docs: Create a new conversation
  - info:
      name: Retrieve a conversation
      type: http
    http:
      method: GET
      url: https://api.botpress.com/v1/chat/conversations/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Retrieve a conversation
  - info:
      name: Delete a conversation
      type: http
    http:
      method: DELETE
      url: https://api.botpress.com/v1/chat/conversations/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Delete a conversation
  - info:
      name: Get or create a conversation
      type: http
    http:
      method: POST
      url: https://api.botpress.com/v1/chat/conversations/get-or-create
    docs: Get or create a conversation
- info:
    name: Messages
    type: folder
  items:
  - info:
      name: List messages
      type: http
    http:
      method: GET
      url: https://api.botpress.com/v1/chat/messages
    docs: List messages
  - info:
      name: Create a new message
      type: http
    http:
      method: POST
      url: https://api.botpress.com/v1/chat/messages
    docs: Create a new message
  - info:
      name: Update message tags and payload
      type: http
    http:
      method: PUT
      url: https://api.botpress.com/v1/chat/messages
    docs: Update message tags and payload
  - info:
      name: Retrieve a message
      type: http
    http:
      method: GET
      url: https://api.botpress.com/v1/chat/messages/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Retrieve a message
  - info:
      name: Delete a message
      type: http
    http:
      method: DELETE
      url: https://api.botpress.com/v1/chat/messages/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Delete a message
- info:
    name: Users
    type: folder
  items:
  - info:
      name: List users
      type: http
    http:
      method: GET
      url: https://api.botpress.com/v1/chat/users
    docs: List users
  - info:
      name: Create a user
      type: http
    http:
      method: POST
      url: https://api.botpress.com/v1/chat/users
    docs: Create a user
  - info:
      name: Retrieve a user
      type: http
    http:
      method: GET
      url: https://api.botpress.com/v1/chat/users/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Retrieve a user
  - info:
      name: Update user information
      type: http
    http:
      method: PUT
      url: https://api.botpress.com/v1/chat/users/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Update user information
  - info:
      name: Delete a user
      type: http
    http:
      method: DELETE
      url: https://api.botpress.com/v1/chat/users/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Delete a user
- info:
    name: Files
    type: folder
  items:
  - info:
      name: List files
      type: http
    http:
      method: GET
      url: https://api.botpress.com/v1/files
    docs: List files
  - info:
      name: Create or upsert files
      type: http
    http:
      method: POST
      url: https://api.botpress.com/v1/files
    docs: Create or upsert files
  - info:
      name: Retrieve file details
      type: http
    http:
      method: GET
      url: https://api.botpress.com/v1/files/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Retrieve file details
  - info:
      name: Delete a file
      type: http
    http:
      method: DELETE
      url: https://api.botpress.com/v1/files/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Delete a file
  - info:
      name: Search file contents
      type: http
    http:
      method: GET
      url: https://api.botpress.com/v1/files/search
    docs: Search file contents
- info:
    name: Tables
    type: folder
  items:
  - info:
      name: List tables
      type: http
    http:
      method: GET
      url: https://api.botpress.com/v1/tables
    docs: List tables
  - info:
      name: Create a table
      type: http
    http:
      method: POST
      url: https://api.botpress.com/v1/tables
    docs: Create a table
  - info:
      name: Insert table rows
      type: http
    http:
      method: POST
      url: https://api.botpress.com/v1/tables/:id/rows
      params:
      - name: id
        value: ''
        type: path
    docs: Insert table rows
  - info:
      name: Update table rows
      type: http
    http:
      method: PUT
      url: https://api.botpress.com/v1/tables/:id/rows
      params:
      - name: id
        value: ''
        type: path
    docs: Update table rows
  - info:
      name: Query table rows
      type: http
    http:
      method: POST
      url: https://api.botpress.com/v1/tables/:id/rows/find
      params:
      - name: id
        value: ''
        type: path
    docs: Query table rows
- info:
    name: Admin
    type: folder
  items:
  - info:
      name: List bots
      type: http
    http:
      method: GET
      url: https://api.botpress.com/v1/admin/bots
    docs: List bots
  - info:
      name: Create a bot
      type: http
    http:
      method: POST
      url: https://api.botpress.com/v1/admin/bots
    docs: Create a bot
  - info:
      name: Update a bot
      type: http
    http:
      method: PUT
      url: https://api.botpress.com/v1/admin/bots/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Update a bot
  - info:
      name: Delete a bot
      type: http
    http:
      method: DELETE
      url: https://api.botpress.com/v1/admin/bots/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Delete a bot
  - info:
      name: List workspaces
      type: http
    http:
      method: GET
      url: https://api.botpress.com/v1/admin/workspaces
    docs: List workspaces
  - info:
      name: Create a workspace
      type: http
    http:
      method: POST
      url: https://api.botpress.com/v1/admin/workspaces
    docs: Create a workspace
bundled: true