Generate Message

POSThttps://api.trillet.ai/v1/api/conversations/message/generate

Headers

x-api-keystringrequired

API key used for authenticating requests to the API.

x-workspace-idstringrequired

Workspace identifier for the API.

Request Body

flowIdstringrequired

Unique identifier for the message flow sending the message. Ensure the Message Flow ID belongs to an active flow.

tostringrequired

Recipient's contact information. Use E.164 format for SMS (e.g., +1234567890) and a valid email address format for Email (e.g., user@example.com).

Ensure the contact format matches the messageChannel type: SMS for phone numbers and Email for email addresses. Using an incorrect format or type will result in an error.

metadataobject

autopilotbooleanrequired

Enable automatically sending the generated message to the intended recipient. If your flow has a delay enabled, the message will be sent after that delay. Defaults to false.

dynamicobject

Dynamic inputs for AI-generated messages.

Response Fields

statusstring

Indicates (success) if the request was successful.

conversation_idstring

Unique identifier for the newly created or fetched existing conversation.

message_idstring

Unique identifier for the newly created message within the conversation.

messagestring

Content of the message sent. This will always be the corresponding message flow's initiationMessage.

{  
  "status": "success",  
  "conversation_id": "63e63b2a-8b6d-4ea4-ae84-abc123",  
  "message_id": "56f3459b-c23d-46a4-8a2d-bcd456",  
  "message": "Your appointment is confirmed for tomorrow at 3 PM."  
}