Get Message Flow
Retrieve a specific message flow.
Headers
x-workspace-idstringrequiredWorkspace identifier for the API.
Path Parameters
idstringrequiredThe unique ID of the message flow.
Response Fields
_idstringThe unique identifier for the message flow.
workspaceIdstringThe identifier of the workspace where the message flow is configured.
namestringThe name of the message flow.
directionstringIndicates the direction of the message flow, such as "bidirectional".
descriptionstringA brief description of what the message flow is designed to handle.
agentobjectThe message agent the flow uses, as a full agent object (use agent._id for its ID), or null.
folderIdobjectThe folder the flow is in, as { _id, name, icon, color }, or null.
settingsobjectThe configuration settings for the message flow.
knowledgeBasesarrayAn array of knowledge base resources linked to the message flow, if any.
securityobjectSecurity settings associated with the message flow.
promptstringThe system or initial prompt set for interacting through the message flow.
isActivebooleanIndicates whether the message flow is currently active.
autopilotbooleanWhether replies are sent automatically without approval. Separate from isActive.
messageChannelstringThe channel: Twilio-SMS, Telnyx-SMS, Twilio-Email, Meta-Whatsapp, Meta-Facebook, Infobip-Whatsapp or Infobip-Facebook.
createdAtstringThe timestamp when the message flow was created.
updatedAtstringThe timestamp when the message flow was last updated.
{
"_id": "exampleId1",
"workspaceId": "exampleWorkspaceId1",
"name": "My-SMS-Flow",
"direction": "bidirectional",
"description": "Example message flow for SMS marketing",
"agent": { "_id": "c9c9c9c9c9c9c9c9c9c9c9c9", "name": "SMS Agent" },
"folderId": null,
"settings": {
"knowledgeBases": [],
"security": {}
},
"prompt": "You are an AI that handles inbound messages.",
"isActive": true,
"autopilot": false,
"messageChannel": "Twilio-SMS",
"createdAt": "2025-01-02T10:15:00Z",
"updatedAt": "2025-01-02T10:30:00Z"
}Last updated on