Get audience messages

Get the message history for an audience draft conversation.

GET /v0/pages/{page_id}/audiences/{audience_id}/messages

Get audience messages

cURL

curl --request GET \
  --url https://api.tryarchitect.com/v0/pages/{page_id}/audiences/{audience_id}/messages \
  --header 'x-api-key: <api-key>'

200

{
  "conversation": {
    "conversationId": "<string>",
    "audienceId": "<string>",
    "publishedMessageId": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>"
  },
  "messages": [
    {
      "messageId": "<string>",
      "content": "<string>",
      "timestamp": 123,
      "hasSnapshot": true,
      "changes": [
        {
          "changeId": "<string>",
          "previousValue": "<string>",
          "newValue": "<string>"
        }
      ],
      "reasoning": "<string>",
      "isInterrupted": true
    }
  ],
  "context": {
    "audienceId": "<string>",
    "pageId": "<string>",
    "currentSupplementaryContext": "<string>",
    "currentMetaTitle": "<string>",
    "currentMetaDescription": "<string>",
    "currentMetaKeywords": "<string>",
    "pageContext": "<string>"
  },
  "pendingChanges": [
    {
      "changeId": "<string>",
      "previousValue": "<string>",
      "newValue": "<string>"
    }
  ]
}

Authorizations

x-api-key · string · header · required

API key authentication for the External Actor Gateway

Path Parameters

page_id · string · required

page_id parameter

audience_id · string · required

audience_id parameter

Response

200

application/json

Successful operation

conversation · object · required

Show child attributes

messages · object[] · required

Show child attributes

context · object · required

Show child attributes

pendingChanges · object[] · required

Show child attributes