GET
/
v1
/
api
/
call-flows
/
{id}
curl --request GET \
  --url https://api.trillet.ai/v1/api/call-flows/{id} \
  --header 'x-api-key: <api-key>' \
  --header 'x-workspace-id: <x-workspace-id>'
{
  "_id": "exampleId",
  "workspaceId": "workspacePlaceholder",
  "name": "Customer Support Flow",
  "direction": "inbound",
  "description": "Handles inbound support calls",
  "agent": "agentPlaceholder",
  "promptType": "simple",
  "flowData": {
    "nodes": [],
    "edges": []
  },
  "prompt": "Keep the conversation short and friendly.",
  "isActive": true,
  "settings": {
    "knowledgeBases": [],
    "responseSettings": { "delay": 0 },
    "security": { "hipaaCompliance": false },
    "callSetting": { "maxCallDuration": 600, "endCallOnSilence": 10 }
  },
  "createdAt": "2025-01-03T11:00:00Z",
  "updatedAt": "2025-01-03T11:10:00Z",
  "__v": 0
}

​
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 call flow.

​
Response Fields

​
_id
string

The unique identifier for the call flow.

​
workspaceId
string

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

​
name
string

The name assigned to the call flow.

​
direction
string

Indicates the direction of the call flow, such as “inbound”.

​
description
string

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

​
agent
string

The ID of the agent associated with this call flow.

​
promptType
string

The type of prompt used in the call flow, such as “simple”.

​
flowData
object

Contains the configuration of nodes and edges defining the call routing logic.

​
nodes
array

An array detailing each node in the call flow.

​
edges
array

An array detailing the edges connecting the nodes.

​
prompt
string

The initial or system prompt that is presented in the call flow.

​
isActive
boolean

Indicates whether the call flow is currently active.

​
settings
object

The configuration settings for the call flow, including details on knowledge bases, response settings, security measures, and call settings.

​
knowledgeBases
array

An array of references to knowledge bases included in the call flow.

​
responseSettings
object

Settings related to response timing within the call flow.

​
delay
number

The delay before a response is issued, measured in seconds.

​
security
object

Security settings relevant to the call flow.

​
hipaaCompliance
boolean

Indicates whether HIPAA compliance is enabled.

​
callSetting
object

Call-related settings for managing the call duration and handling silence.

​
maxCallDuration
number

The maximum duration for the call, measured in seconds.

​
endCallOnSilence
number

The duration of silence that triggers the end of the call, measured in seconds.

​
createdAt
string

Timestamp when the call flow was created.

​
updatedAt
string

Timestamp when the call flow was last updated.

​
__v
number

The version number of the call flow document.

{
  "_id": "exampleId",
  "workspaceId": "workspacePlaceholder",
  "name": "Customer Support Flow",
  "direction": "inbound",
  "description": "Handles inbound support calls",
  "agent": "agentPlaceholder",
  "promptType": "simple",
  "flowData": {
    "nodes": [],
    "edges": []
  },
  "prompt": "Keep the conversation short and friendly.",
  "isActive": true,
  "settings": {
    "knowledgeBases": [],
    "responseSettings": { "delay": 0 },
    "security": { "hipaaCompliance": false },
    "callSetting": { "maxCallDuration": 600, "endCallOnSilence": 10 }
  },
  "createdAt": "2025-01-03T11:00:00Z",
  "updatedAt": "2025-01-03T11:10:00Z",
  "__v": 0
}