Get Message Flow

Retrieve a specific message flow.

GET /v1/api/message-flows/{id}

Get Message Flow

cURL

curl --request GET \
  --url https://api.trillet.ai/v1/api/message-flows/{id} \
  --header 'x-api-key: <api-key>' \
  --header 'x-workspace-id: <x-workspace-id>'

{
  "_id": "exampleId1",
  "workspaceId": "exampleWorkspaceId1",
  "name": "My-SMS-Flow",
  "direction": "bidirectional",
  "description": "Example message flow for SMS marketing",
  "agent": "exampleAgentId1",
  "settings": {
    "knowledgeBases": [],
    "security": {}
  },
  "prompt": "You are an AI that handles inbound messages.",
  "isActive": true,
  "autopilot": false,
  "messageChannel": "SMS",
  "createdAt": "2025-01-02T10:15:00Z",
  "updatedAt": "2025-01-02T10:30:00Z"
}

Headers

x-api-key · string · required

API key used for authenticating requests to the API.

x-workspace-id · string · required

Workspace identifier for the API.

Path Parameters

id · string · required

The unique ID of the message flow.

Response Fields

_id · string

The unique identifier for the message flow.

workspaceId · string

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

name · string

The name of the message flow.

direction · string

Indicates the direction of the message flow, such as “bidirectional”.

description · string

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

agent · string

The identifier of the agent associated with this message flow.

settings · object

The configuration settings for the message flow.

knowledgeBases · array

An array of knowledge base resources linked to the message flow, if any.

security · object

Security settings associated with the message flow.

prompt · string

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

isActive · boolean

Indicates whether the message flow is currently active.

autopilot · boolean

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

messageChannel · string

The type of communication channel used by the message flow, such as “SMS”.

createdAt · string

The timestamp when the message flow was created.

updatedAt · string

The 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": "exampleAgentId1",
  "settings": {
    "knowledgeBases": [],
    "security": {}
  },
  "prompt": "You are an AI that handles inbound messages.",
  "isActive": true,
  "autopilot": false,
  "messageChannel": "SMS",
  "createdAt": "2025-01-02T10:15:00Z",
  "updatedAt": "2025-01-02T10:30:00Z"
}