Jump to Content
Docs
For Developers
Changelog
For Developers
Moon (Dark Mode)
Sun (Light Mode)
Docs
For Developers
Changelog
Create Personal Access Token
Search
All
Pages
Start typing to search…
JUMP TO
Chat API
Introduction
Endpoints
Create User
post
Get Or Create User
post
Get Conversation
get
Delete Conversation
delete
Create Conversation
post
List Conversations
get
Get Or Create Conversation
post
Listen Conversation
get
List Messages
get
Add Participant
post
List Participants
get
Remove Participant
delete
Get Participant
get
Get Message
get
Delete Message
delete
Create Message
post
Get User
get
Update User
put
Delete User
delete
Get Event
get
Create Event
post
Botpress API
Introduction
Authentication
Conversations
Create Conversation
post
List Conversations
get
Get Conversation
get
Update Conversation
put
Delete Conversation
delete
Get Or Create Conversation
post
Conversation participants
List Participants
get
Add Participant
post
Get Participant
get
Remove Participant
delete
Conversation events
Create Event
post
List Events
get
Get Event
get
Conversation messages
Create Message
post
List Messages
get
Get Or Create Message
post
Get Message
get
Update Message
put
Delete Message
delete
Conversation users
Create User
post
List Users
get
Get User
get
Update User
put
Delete User
delete
Get Or Create User
post
Integrations
Configure Integration
post
List Integration Api Keys
get
Create Integration Api Key
post
Delete Integration Api Key
delete
Create Integration
post
List Integrations
get
Update Integration
put
Get Integration
get
Delete Integration
delete
Get Integration Logs
get
Get Integration By Name
get
Request Integration Verification
post
Account management
Get Account
get
Update Account
put
List Personal Access Tokens
get
Create Personal Access Token
post
Delete Personal Access Token
delete
Hub
List Public Integrations
get
Get Public Integration By Id
get
Get Public Integration
get
Bots
Create Bot
post
List Bots
get
Update Bot
put
Get Bot
get
Delete Bot
delete
Get Bot Logs
get
Get Bot Analytics
get
Get Bot Issue
get
Delete Bot Issue
delete
List Bot Issues
get
List Bot Issue Events
get
List Bot Versions
get
Create Bot Version
post
Get Bot Version
get
Deploy Bot Version
post
Workspaces
Create Workspace
post
List Workspaces
get
Get Public Workspace
get
Get Workspace
get
Update Workspace
put
Delete Workspace
delete
List Workspace Usages
get
Break Down Workspace Usage By Bot
get
Get Workspace Quota
get
List Workspace Quotas
get
List Public Workspaces
get
Get Audit Records
get
List Workspace Members
get
Create Workspace Member
post
Get Workspace Member
get
Delete Workspace Member
delete
Update Workspace Member
put
Usages
Get Usage
get
List Usage History
get
List Usage Activity
get
Files
What is the Files API?
Upsert File
put
List Files
get
Delete File
delete
Get File
get
Update File Metadata
put
Search Files
get
List File Passages
get
Tables
List Tables
get
Create Table
post
Get Table
get
Get Or Create Table
post
Update Table
put
Delete Table
delete
Duplicate Table
post
Rename Table Column
put
Get Table Row
get
Find Table Rows
post
Create Table Rows
post
Update Table Rows
put
Delete Table Rows
post
Upsert Table Rows
post
Human in the Loop API Integration
How to use the Botpress Human in the Loop API Integration
Endpoints to implement
Ping your service
post
Create a conversation in your service
post
Close a ticket
post
Create a user
post
Send a message to the agent
post
Calling the API
Send a message from the agent to the bot.
post
Notify that an agent was assigned to a conversation.
post
Stop the human-in-the-loop (HITL) session and close the ticket.
post
Create Personal Access Token
post
https://api.botpress.cloud/v1/admin/account/pats
Create a PAT
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer
PAT
Bearer
RESPONSE
Click
Try It!
to start a request and see the response here!