Get Message Flow

GEThttps://api.trillet.ai/v1/api/message-flows/{id}

Headers

x-api-keystringrequired

API key used for authenticating requests to the API.

x-workspace-idstringrequired

Workspace identifier for the API.

Path Parameters

idstringrequired

The unique ID of the message flow.

Response Fields

_idstring

The unique identifier for the message flow.

workspaceIdstring

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

namestring

The name of the message flow.

directionstring

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

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.

knowledgeBasesarray

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

securityobject

Security settings associated with the message 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".

createdAtstring

The timestamp when the message flow was created.

updatedAtstring

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"
}