chatMessages

Requires an authenticated session.

Lists the messages in one conversation, oldest first, with sender, text and time. The caller must have access to the conversation. Needs a signed-in user.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query ChatMessages($conversationId: String!) {
  chatMessages(conversationId: $conversationId) {
    id
    createdAt
    content
    conversationId
    metadata
    role
    sender {
      id
      postalCode
      name
      firstName
      lastName
      status
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query ChatMessages($conversationId: String!) {\n  chatMessages(conversationId: $conversationId) {\n    id\n    createdAt\n    content\n    conversationId\n    metadata\n    role\n    sender {\n      id\n      postalCode\n      name\n      firstName\n      lastName\n      status\n    }\n  }\n}",
  "variables": {
    "conversationId": "string"
  }
}
EOF

Variables:

{
  "conversationId": "string"
}

Response:

{
  "data": {
    "chatMessages": [
      {
        "id": "id",
        "createdAt": "2025-01-15T00:00:00Z",
        "content": "string",
        "conversationId": "string",
        "metadata": {},
        "role": "string",
        "sender": {
          "id": "id",
          "postalCode": "string",
          "name": "string",
          "firstName": "string",
          "lastName": "string",
          "status": "ACTIVE"
        }
      }
    ]
  }
}

chatMessages(
  conversationId: String!
): [ChatMessage!]!

Arguments

chatMessages.conversationId ● String! non-null scalar

The ID of the conversation.

Type

ChatMessage object

One message in a chat conversation.