getMessage

Retrieves the Message object for a valid identifier.

GET/v1/chat/messages/{id}

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

Path parameters

idstring

Id of the Message

Response

Returns a Message object if a valid identifier was provided. Returns an Error otherwise

messageobject

The Message object represents a message in a Conversation for a specific User.

Request

curl --request GET \ \
  --url https://api.botpress.cloud/v1/chat/messages/{id} \
  --header 'x-bp-authenticated-principal: <x-bp-authenticated-principal>' \
  --header 'x-bot-id: <x-bot-id>' \
  --header 'Authorization: Bearer <token>'

Response

{
  "message": {
    "id": "string",
    "createdAt": "2025-01-15T12:00:00Z",
    "updatedAt": "2025-01-15T12:00:00Z",
    "type": "string",
    "payload": {},
    "direction": "incoming",
    "userId": "string",
    "conversationId": "string",
    "tags": {
      "key": "string"
    },
    "origin": "synthetic"
  }
}