Send Message

Endpoint used to send a message to the agent.

Request Example

curl --request POST \
  --url https://kratos.api.toolzz.com.br/api/v1/chat/send-message \
  --header 'Authorization: Bearer TOKEN_HERE' \
  --header 'Content-Type: application/json' \
  --data '
    {
        "message": "<string>",
        "conversationId": "<string>",
        "botId": "<uuid>"
    }
'

Response Example

{
  "message": {
    "content": "<string>",
    "conversationId": "<string>",
    "transferToAgent": true,
    "targetBotId": "<uuid>"
  }
}

---

Request description

Access Token

Parameter	Type	Description	Required
Authorization	String	Access token (“Bearer” must be before the token)	Yes

Body Parameters

Parameter	Type	Description	Required
message	String	The text content of the message to be sent to the agent.	Yes
conversationId	String	Unique identifier of the conversation session.	No
botId	UUID	Unique identifier of the agent (bot).	Yes

Note

It is possible to start a new conversation without sending the conversationId parameter, but to send messages to the same conversation, it is necessary to provide the conversationId in the request.

Response description

Key	Type	Description
message	Object	Object containing the interaction details and routing metadata.
message.content	String	Textual content of the generated response or system message.
message.conversationId	String	Unique identifier of the active conversation.
message.transferToAgent	Boolean	Indicates if the conversation should be transferred to a human agent or another support level.
message.targetBotId	UUID	Identifier of the target Agent if the transfer occurs between bots.

---

Security

To access this endpoint, it is necessary to send a valid access token through the authorization header (Authorization) of the request. Additionally, the API is protected by other security measures to safeguard user data.

To access your access token, follow these steps:

1. Log in to the ToolzzAI platform
2. Click on “Settings”
3. Click on “Access Token”
4. Copy the access token