POST
/
agents
/
{agent_id}
/
interact
/
{user_id}

Authorizations

Authorization
string
header
required

Agent/Workspace secret API key as bearer token.

Path Parameters

agent_id
string
required

The ID of the agent to interact with

user_id
string
required

The ID of the user to interact with

Body

application/json
action
object
appendMessages
object[]

Messages to append to the conversation.

origin
enum<string>

Channel to send message through.

Available options:
web-chat,
whatsapp,
discord,
gb-chat
transcriptMetadata
object

Metadata related to the conversation transcript.

variables
object

Variables to inject to VF.

Response

200 - application/json
message
string
required

General message.

platformName
enum<string>
required

Name of the platform (virtual flow or TIXAE Agents).

Available options:
vf,
vg
success
boolean
required

Indicates if the interaction was successful.

actionMessages
any[]

Messages related to actions.

agentData
object

Data related to the agent in the conversation.

agentID
string

Agent ID.

appError
string

Error message related to the app.

chatState
object

State of the chat.

oldTurns
object[]

Previously recorded turns in the conversation.

origin
enum<string>

Origin of the message.

Available options:
web-chat,
whatsapp,
discord,
gb-chat
turns
object[]

Turns in the conversation.

userID
string

User/Conversation ID.