POST
/
messages
import { ProficientClient } from "@proficient/client";

const proficient = new ProficientClient({
  apiKey: process.env.PROFICIENT_AI_PUBLISHABLE_KEY,
  userExternalId: "...", // The user's unique ID in your system
});

const interactionId = "int_53mfKtX0Da6zaJCp5bNnzxDaEg1xptWvQDr2";

const message = await proficient.messages.create({
  interactionId,
  content: "Hello! Tell me something about Anaximander.",
});

{
  "id": "<string>",
  "object": "message",
  "content": "<string>",
  "created_at": 123,
  "depth": 123,
  "interaction_id": "<string>",
  "parent_id": "<string>",
  "sent_by": "user"
}

Body

application/json

The data with which a message is created.

​
content
string
required

The content of the message

​
interaction_id
string
required

The unique identifier of the interaction

​
parent_id
string | null

Response

200 - application/json
<p>Each interaction holds a number of <i>messages</i> and every message belongs to an interaction. The `sent_by` property of a message indicates whether a message was created by an agent or a user.</p>
​
content
string
required

The content of the message

​
created_at
integer
required

The time at which the object was created, measured in milliseconds since the Unix epoch

​
depth
integer
required

The depth of the message node in the interaction tree. This will be 0 for all root-level messages that mark the beginning of the interaction and increase as the conversation grows longer.

​
id
string
required

The unique identifier of the message

​
interaction_id
string
required

The unique identifier of the interaction

​
object
enum<string>
required

The type of the Message object

Available options:
message
​
sent_by
enum<string>
required

Represents the type of the participant in a given interaction. As an example, message are created by interaction participants so the sent_by property of a Message object must be an InteractionParticipant.

Available options:
user,
agent
​
parent_id
string | null

The ID of the message that directly precedes a given message within a particular conversation.

List all messages in an interactionRetrieve a message