POST /conversations
usecase
field determines the conversation’s purpose and behavior:
"usecase": "DEFAULT"
)
"usecase": "WORKFLOW_EXECUTION"
)
workflow_id
from configcallback_url
in config
to receive a webhook/callback on every message of conversation.
WORKFLOW_EXECUTION
, the metadata will automatically include the workflow_id from configDEFAULT
usecase provides the most flexibility for custom implementationschannel
field is used to specify the communication channel, currently only API
is supportedcallback_url
in config
201
: Conversation created successfully400
: Invalid request data401
: Invalid or missing API key500
: Server errorGET /conversations/{conversation_id}/messages
conversation_id
: The ID of the conversation200
: Success404
: Conversation not found500
: Server errorTEXT
: Regular text messagesIMAGE
: Image filesVIDEO
: Video filesAUDIO
: Audio filesUSER_INPUT
: Messages from usersRECEIVED
: Message has been receivedid
: Unique message identifiercontent
: Message content/textfilename
: Present only for media messagesmetadata
: Optional JSON object for additional data