callAction

Call an action

POST /v1/chat/actions

cURL

cURL

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

200

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

Authorizations

Authorization · string · header · required

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

Headers

x-bp-authenticated-principal · string · required

Authenticated principal. Injected by the authentication middleware.

x-bot-id · string · required

Bot id

x-integration-id · string

Integration id

x-integration-alias · string

Integration alias

x-real-ip · string

Caller's IP address. Injected by the edge proxy.

Body

application/json

Action payload

type · string · required

Type of the action

Maximum string length: 200

input · object · required

Input of the action

Response

200

application/json

Action payload

output · object · required

Input of the action

meta · object · required

Show child attributes