answer.created

This event is emitted when a generated answer has been fully produced and sent. It marks the successful completion of the answer generation process and delivers the finalized answer payload

projectId

string

required

The unique identifier of the project in which the answer was generated.

answer

object

required

An object representing the final answer produced by the platform.

Hide child attributes

answer.id

string

required

Answer's unique id.

Example:

"answer_XXXXXXXXXXXXXXXXXX"

answer.userProfileId

string

required

References the user profile id.

answer.personaProfileId

string

required

References the persona profile id.

answer.type

enum<string>

required

deprecated

Answer's type.

Available options:

TEXT

answer.tags

object

required

A map of tags to associate with the generated answer. You can use any key-value pair to store additional information along with your request. You can use this to store arbitrary metadata, for events tracking or statistics.

Hide child attributes

answer.tags.{key}

string

answer.cost

string

required

Answer's cost that has a precision of up to 4-digits represented as a string. Format: 0.0000.

Example:

"0.025"

answer.responseTime

integer<int64>

required

Answer's response time in seconds.

answer.sequenceNumber

integer<int32>

required

Answer's sequence number, will be greater than 0 when a reply contains multiple messages.

answer.createdAt

string<date-time>

required

Answer's creation date. Format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX (iso-8601)

answer.text

string

Answer's text.

Example:

"Lorem ipsum dolor sit amet."

answer.pictureUrl

string | null

Answer's attached picture url.

answer.conversationStopReason

enum<string> | null

Answer's conversation stop reason. All ban periods are customizable and can be progressive. By default, progressive ban are 2 hours → 12 hours → 24 hours → 48 hours → Permanent

Value	Description	Ban Period
`USER_UNDERAGE`	Minor user detected (under 18 years old).	Permanent
`USER_SUSPICIOUS`	User is trying to hijack the AI.	Permanent
`USER_MESSAGE_REPETITION`	Suspicious behavior detected, user is repeating the same message.	Progressive
`UNKNOWN_LANGUAGE`	Suspicious behavior detected, user is using an unknown language.	Progressive
`USER_HOSTILE`	Hostile behaviour toward Persona detected.	Progressive
`AI_SUSPICION`	The user suspects that the Persona is an AI.	Progressive

Available options:

USER_UNDERAGE,

MALICIOUS_CONTENT,

USER_SUSPICIOUS,

USER_MESSAGE_REPETITION,

UNKNOWN_LANGUAGE,

USER_HOSTILE,

AI_SUSPICIOUS,

PAUSE_CONVERSATION

answer.conversationStoppedUntil

string | null

Answer's conversation stopped until.

answer.parentAnswerId

string

Answer's parent answer id.

Content Creation

Documentation Index