Conversation

You interact with AI characters by having conversations with them. Messages get sent and received within conversations.

  {
      "id": "661174a67e9ce0299b57d280",
      "createdAt": "2024-04-06T16:13:26.909Z",
      "isExternal": true,
      "latestMessageId": "661174a8a2f885bc11e4021c",
      "openai": {
          "threadId": "thread_f5yKKKlYkFCy8mdok9lVul6B"
      },
      "orgId": "650796b9857d58124448976a",
      "source": "CHAT_WIDGET",
      "updatedAt": "2024-04-06T16:13:28.067Z"
  }

Properties

id ^string

The unique ID of the conversation.

isExternal ^boolean

A boolean value that determines if the conversation was created within the ProteusAI app (value is false) or if the conversation was created in an integration like a chat widget (value is true). Internal conversations are interpreted as test conversations and do not contribute to the account's monthly billing.

latestMessageId ^string

The unique ID of the latest message in the conversation.

source ^{MessageSource}

The place where the conversation was created.

state ^{string optional}

This is a stringified JSON object that holds key-value pairs representing the current state of the conversation. The conversation state is a good place to store information you's like to programmatically retrieve later, such as the identity of the user having that conversation.