Get Call Flow

GEThttps://api.trillet.ai/v1/api/call-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 call flow.

Response Fields

_idstring

The unique identifier for the call flow.

workspaceIdstring

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

namestring

The name assigned to the call flow.

directionstring

Indicates the direction of the call flow, such as "inbound".

descriptionstring

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

agentstring

The ID of the agent associated with this call flow.

promptTypestring

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

flowDataobject

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

nodesarray

An array detailing each node in the call flow.

edgesarray

An array detailing the edges connecting the nodes.

promptstring

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

isActiveboolean

Indicates whether the call flow is currently active.

settingsobject

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

knowledgeBasesarray

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

responseSettingsobject

Settings related to response timing within the call flow.

delaynumber

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

securityobject

Security settings relevant to the call flow.

hipaaComplianceboolean

Indicates whether HIPAA compliance is enabled.

callSettingobject

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

maxCallDurationnumber

The maximum duration for the call, measured in seconds.

endCallOnSilencenumber

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

createdAtstring

Timestamp when the call flow was created.

updatedAtstring

Timestamp when the call flow was last updated.

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