List Message Flows

GEThttps://api.trillet.ai/v1/api/message-flows

Headers

x-api-keystringrequired

API key used for authenticating requests to the API.

x-workspace-idstringrequired

Workspace identifier for the API.

Response Fields

Each object in the response array represents a message flow, containing the following fields:

_idstring

The unique identifier for each message flow.

workspaceIdstring

The identifier of the workspace where each message flow is configured.

namestring

The name of the message flow.

directionstring

Indicates the direction of the message flow, such as "bidirectional" or "outbound".

descriptionstring

A brief description of what the message flow is designed to handle.

agentstring

The identifier of the agent associated with this message flow.

settingsobject

The configuration settings for the message flow. This field may contain various subfields depending on the specific configurations set for each flow.

promptstring

The system or initial prompt set for interacting through the message flow.

isActiveboolean

Indicates whether the message flow is currently active.

autopilotboolean

Specifies whether autopilot is enabled, allowing the message flow to operate automatically.

messageChannelstring

The type of communication channel used by the message flow, such as "SMS" or "Email".

createdAtstring

The timestamp when the message flow was created.

updatedAtstring

The timestamp when the message flow was last updated.

[
  {
    "_id": "exampleId1",
    "workspaceId": "exampleWorkspaceId1",
    "name": "SMS Flow #1",
    "direction": "bidirectional",
    "description": "Example #1",
    "agent": "exampleAgentId1",
    "settings": {},
    "prompt": "Short prompt for AI",
    "isActive": true,
    "autopilot": false,
    "messageChannel": "SMS",
    "createdAt": "2025-01-02T10:15:00Z",
    "updatedAt": "2025-01-02T10:30:00Z"
  },
  {
    "_id": "exampleId2",
    "workspaceId": "exampleWorkspaceId2",
    "name": "Email Nurture Flow",
    "direction": "outbound",
    "description": "Send follow-up emails to leads",
    "agent": "exampleAgentId2",
    "settings": {},
    "prompt": "You are an email follow-up AI.",
    "isActive": false,
    "autopilot": false,
    "messageChannel": "Email",
    "createdAt": "2025-01-03T11:00:00Z",
    "updatedAt": "2025-01-03T11:15:00Z"
  }
]