callAction

Call an action

POST/v1/chat/actions

Authorization

AuthorizationBearer

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Header parameters

x-bp-authenticated-principalstring

Authenticated principal. Injected by the authentication middleware.

x-bot-idstring

Bot id

x-integration-id?string

Integration id

x-integration-alias?string

Integration alias

Request body

Action payload

typestring

Type of the action(max length: 200)

inputobject

Input of the action

Response

Action payload

outputobject

Input of the action

metaobject

Request

curl --request POST \ \
  --url https://api.botpress.cloud/v1/chat/actions \
  --header 'x-bp-authenticated-principal: <x-bp-authenticated-principal>' \
  --header 'x-bot-id: <x-bot-id>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "",
  "input": {}
}
'

Response

{
  "output": {},
  "meta": {
    "cached": true
  }
}