Message

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

  {
      "id": "65f5e2dabdc259f06b9cd7cb",
      attachments: [{
          content: 'https://files.cdn/about-proteusai.txt',
          type: 'FILE_URL'
      }],
      "content": "Can you tell me a little bit more about ProteusAI?",
      "conversationId": "66647e2a9b7df22968809d0a",
      "createdAt": "2024-04-06T16:13:26.909Z",
      "isExternal": true,
      "notes": [],
      "openai": {
          "messageId": "msg_Y4EnwvVfnq6AE9jLpdZarLGv"
      },
      "senderId": "650796b9857d58124448976a",
      "source": "CHAT_WIDGET",
      "type": "TEXT",
      "updatedAt": "2024-04-06T16:13:28.067Z"
  }

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 packets of a message, this is the portion of the content of the message that is generated in a specific packet.

conversationId ^string

The ID of the conversation to which the message was sent.

isExternal ^boolean

A boolean value that determines if the message was created within the ProteusAI app (value is false) or if the message was created in an integration like a chat widget (value is true).

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.

repliedToId ^{string optional}

The ID of the message to which this message replies.

senderId ^string

The ID of the entity that sent the message. The sender can be a user or an AI character.

source ^{MessageSource}

The place where the message was created.

type ^MessageType

The type of the content of a message.