getState

Retrieves the State object for a valid identifiers.

GET /v1/chat/states/{type}/{id}/{name}

cURL

cURL

curl --request GET \
  --url https://api.botpress.cloud/v1/chat/states/{type}/{id}/{name} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-bot-id: <x-bot-id>'

200

{
  "state": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "botId": "<string>",
    "name": "<string>",
    "payload": {},
    "conversationId": "<string>",
    "userId": "<string>"
  },
  "meta": {
    "cached": true
  }
}

Authorizations

Authorization · string · header · required

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

Headers

x-bot-id · string · required

Bot id

x-integration-id · string

Integration id

x-integration-alias · string

Integration alias

Path Parameters

type · enum<string> · required

Represents the resource type that the state is related to

Available options: conversation, user, bot, integration, workflow

id · string · required

Id of the State which will be either the botId, the userId or the conversationId

name · string · required

Name of the State which is declared inside the bot definition

Response

200

application/json

Returns the State object if a valid identifiers were provided. Returns an error otherwise

state · object · required

The state object represents the current payload. A state is always linked to either a bot, a conversation or a user.

Show child attributes

meta · object · required

Show child attributes