Chat API

Introduction
Endpoints

Botpress API

Introduction
Authentication
Conversations
Conversation participants
Conversation events
Conversation messages
Conversation users
Integrations
Account management
Hub
Bots
Workspaces
Usages
Files
Tables

Human in the Loop API Integration

How to use the Botpress Human in the Loop API Integration
Endpoints to implement
Calling the API

Chat API

Introduction
Endpoints

Botpress API

Introduction
Authentication
Conversations
Conversation participants
Conversation events
Conversation messages
Conversation users
Integrations
Account management
Hub
Bots
Workspaces
Usages
Files
Tables

Human in the Loop API Integration

How to use the Botpress Human in the Loop API Integration
Endpoints to implement
Calling the API

Get Usage

get https://api.botpress.cloud/v1/admin/usages/{id}

Get usage

URL Expired

The URL for this request expired after 30 days.

Path Params

string

required

ID of a bot or a workspace, depending on the "type" parameter

Query Params

type

string

required

Usage type

period

string

Period to get

Responses

Response body

object

usage

object

required

string

required

Id of the usage that it is linked to. It can either be a workspace id or a bot id

period

string

required

Period of the quota that it is applied to

value

number

required

Value of the current usage

quota

number

required

Quota of the current usage

type

string

required

Usage type that can be used

invocation_timeout invocation_calls storage_count bot_count knowledgebase_vector_storage workspace_ratelimit table_row_count workspace_member_count integrations_owned_count ai_spend openai_spend bing_search_spend always_alive

Response body

object

usage

object

required

string

required

Id of the usage that it is linked to. It can either be a workspace id or a bot id

period

string

required

Period of the quota that it is applied to

value

number

required

Value of the current usage

quota

number

required

Quota of the current usage

type

string

required

Usage type that can be used

Updated 5 months ago

Update Workspace Member

List Usage History

Did this page help you?

Language

Credentials

Bearer

PAT


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.botpress.cloud/v1/admin/usages/id?type=invocation_timeout' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 5 months ago

Update Workspace Member

List Usage History

Did this page help you?

Chat API
Introduction
Endpoints
Create Eventpost
Get Eventget
Delete Userdelete
Update Userput
Get Userget
Create Messagepost
Delete Messagedelete
Get Messageget
Get Participantget
Remove Participantdelete
List Participantsget
Add Participantpost
List Messagesget
Listen Conversationget
Get Or Create Conversationpost
List Conversationsget
Create Conversationpost
Delete Conversationdelete
Get Conversationget
Get Or Create Userpost
Create Userpost

Botpress API
Introduction
Authentication
Conversations
Get Or Create Conversationpost
Delete Conversationdelete
Update Conversationput
Get Conversationget
List Conversationsget
Create Conversationpost
Conversation participants
Remove Participantdelete
Get Participantget
Add Participantpost
List Participantsget
Conversation events
Get Eventget
List Eventsget
Create Eventpost
Conversation messages
Delete Messagedelete
Update Messageput
Get Messageget
Get Or Create Messagepost
List Messagesget
Create Messagepost
Conversation users
Get Or Create Userpost
Delete Userdelete
Update Userput
Get Userget
List Usersget
Create Userpost
Integrations
Request Integration Verificationpost
Get Integration By Nameget
Get Integration Logsget
Delete Integrationdelete
Get Integrationget
Update Integrationput
List Integrationsget
Create Integrationpost
Delete Integration Api Keydelete
Create Integration Api Keypost
List Integration Api Keysget
Configure Integrationpost
Account management
Delete Personal Access Tokendelete
Create Personal Access Tokenpost
List Personal Access Tokensget
Update Accountput
Get Accountget
Hub
Get Public Integrationget
Get Public Integration By Idget
List Public Integrationsget
Bots
Deploy Bot Versionpost
Get Bot Versionget
Create Bot Versionpost
List Bot Versionsget
List Bot Issue Eventsget
List Bot Issuesget
Delete Bot Issuedelete
Get Bot Issueget
Get Bot Analyticsget
Get Bot Logsget
Delete Botdelete
Get Botget
Update Botput
List Botsget
Create Botpost
Workspaces
Update Workspace Memberput
Delete Workspace Memberdelete
Get Workspace Memberget
Create Workspace Memberpost
List Workspace Membersget
Get Audit Recordsget
List Public Workspacesget
List Workspace Quotasget
Get Workspace Quotaget
Break Down Workspace Usage By Botget
List Workspace Usagesget
Delete Workspacedelete
Update Workspaceput
Get Workspaceget
Get Public Workspaceget
List Workspacesget
Create Workspacepost
Usages
List Usage Activityget
List Usage Historyget
Get Usageget
Files
List File Passagesget
Search Filesget
Update File Metadataput
Get Fileget
Delete Filedelete
List Filesget
Upsert Fileput
What is the Files API?
Tables
Upsert Table Rowspost
Delete Table Rowspost
Update Table Rowsput
Create Table Rowspost
Find Table Rowspost
Get Table Rowget
Rename Table Columnput
Duplicate Tablepost
Delete Tabledelete
Update Tableput
Get Or Create Tablepost
Get Tableget
Create Tablepost
List Tablesget

Human in the Loop API Integration
How to use the Botpress Human in the Loop API Integration
Endpoints to implement
Send a message to the agentpost
Create a userpost
Close a ticketpost
Create a conversation in your servicepost
Ping your servicepost
Calling the API
Stop the human-in-the-loop (HITL) session and close the ticket.post
Notify that an agent was assigned to a conversation.post
Send a message from the agent to the bot.post

Chat API
Introduction
Endpoints
Create Eventpost
Get Eventget
Delete Userdelete
Update Userput
Get Userget
Create Messagepost
Delete Messagedelete
Get Messageget
Get Participantget
Remove Participantdelete
List Participantsget
Add Participantpost
List Messagesget
Listen Conversationget
Get Or Create Conversationpost
List Conversationsget
Create Conversationpost
Delete Conversationdelete
Get Conversationget
Get Or Create Userpost
Create Userpost

Botpress API
Introduction
Authentication
Conversations
Get Or Create Conversationpost
Delete Conversationdelete
Update Conversationput
Get Conversationget
List Conversationsget
Create Conversationpost
Conversation participants
Remove Participantdelete
Get Participantget
Add Participantpost
List Participantsget
Conversation events
Get Eventget
List Eventsget
Create Eventpost
Conversation messages
Delete Messagedelete
Update Messageput
Get Messageget
Get Or Create Messagepost
List Messagesget
Create Messagepost
Conversation users
Get Or Create Userpost
Delete Userdelete
Update Userput
Get Userget
List Usersget
Create Userpost
Integrations
Request Integration Verificationpost
Get Integration By Nameget
Get Integration Logsget
Delete Integrationdelete
Get Integrationget
Update Integrationput
List Integrationsget
Create Integrationpost
Delete Integration Api Keydelete
Create Integration Api Keypost
List Integration Api Keysget
Configure Integrationpost
Account management
Delete Personal Access Tokendelete
Create Personal Access Tokenpost
List Personal Access Tokensget
Update Accountput
Get Accountget
Hub
Get Public Integrationget
Get Public Integration By Idget
List Public Integrationsget
Bots
Deploy Bot Versionpost
Get Bot Versionget
Create Bot Versionpost
List Bot Versionsget
List Bot Issue Eventsget
List Bot Issuesget
Delete Bot Issuedelete
Get Bot Issueget
Get Bot Analyticsget
Get Bot Logsget
Delete Botdelete
Get Botget
Update Botput
List Botsget
Create Botpost
Workspaces
Update Workspace Memberput
Delete Workspace Memberdelete
Get Workspace Memberget
Create Workspace Memberpost
List Workspace Membersget
Get Audit Recordsget
List Public Workspacesget
List Workspace Quotasget
Get Workspace Quotaget
Break Down Workspace Usage By Botget
List Workspace Usagesget
Delete Workspacedelete
Update Workspaceput
Get Workspaceget
Get Public Workspaceget
List Workspacesget
Create Workspacepost
Usages
List Usage Activityget
List Usage Historyget
Get Usageget
Files
List File Passagesget
Search Filesget
Update File Metadataput
Get Fileget
Delete Filedelete
List Filesget
Upsert Fileput
What is the Files API?
Tables
Upsert Table Rowspost
Delete Table Rowspost
Update Table Rowsput
Create Table Rowspost
Find Table Rowspost
Get Table Rowget
Rename Table Columnput
Duplicate Tablepost
Delete Tabledelete
Update Tableput
Get Or Create Tablepost
Get Tableget
Create Tablepost
List Tablesget

Human in the Loop API Integration
How to use the Botpress Human in the Loop API Integration
Endpoints to implement
Send a message to the agentpost
Create a userpost
Close a ticketpost
Create a conversation in your servicepost
Ping your servicepost
Calling the API
Stop the human-in-the-loop (HITL) session and close the ticket.post
Notify that an agent was assigned to a conversation.post
Send a message from the agent to the bot.post

200Success

defaultSuccess