Message

Messages are the pieces of information being exchanged in a chat. Messages get sent and received within a chat. Messages can be of various types, including text, audio, image, and simple UI forms.

  {
      "id": "6832df10b749a23a30105dba",
      "content": "Can you tell me a little bit more about ProteusAI?",
      "contentDelta": null,
      "chatId": "682f4b313981b5f54e96ea4b",
      "chatKey": null,
      "instructions": [],
      "isStreaming": false,
      "notes": [],
      "respondedToId": null,
      "responseUrl": null,
      "senderId": "6466ae1b03fab9ddd1d67c40",
      "state": {},
      "streamId": null,
      "streamResponse": false,
      "type": "TEXT",
      "createdAt": "2025-05-25T09:12:48.898Z",
      "updatedAt": "2025-05-25T09:12:48.898Z",
      "attachments": [],
      "citations": []
  }

Properties

id ^string

The unique ID of the message.

attachments ^{MessageAttachment[] optional}

An array of attachments to the message.

content ^string

The actual piece of information being shared in the message.

contentDelta ^string

When streaming the chunks of a message, this is the portion of the content that was generated in a specific chunk.

chatId ^string

The ID of the chat the message belongs to.

chatKey ^{string optional}

The stable chat key used to locate or create the chat for this message.

isStreaming ^boolean

A boolean value that determines if the message is currently being streamed (value is true) or if it has been completely sent (value is false).

notes ^{string[] optional}

An array of footnotes added to the message. These are typically citations or references to source materials from which the message was constructed.

respondedToId ^{string optional}

The ID of the message that this message is a reply to.

senderId ^string

The ID of the message participant that sent the message. The sender can be a user, an agent, or an app integration.

streamId ^{string optional}

An identifier that groups the chunks of a single streamed response together.

streamResponse ^{boolean optional}

Whether the reply to this message should be streamed.

type ^MessageType

The type of the content of a message.