Trillet AI logo

Get Call Flow

Retrieve a specific call flow by its ID.

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

Headers

x-workspace-idstringrequired

Workspace identifier for the API.

Path Parameters

idstringrequired

The unique ID of the call flow.

If the flow has unpublished changes from the call flow editor (an active draft), the response is that draft merged over the live flow, for every setting, not only the greeting. Calls received on the flow's number keep using the live version until the draft is published.

Errors

StatusBodyWhen
400{"error": "Workspace ID is required."}No x-workspace-id
500{"message": "Error fetching flow"}Unexpected server error

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

outbound or bidirectional (answers inbound calls and can place outbound ones).

descriptionstring

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

agentobject

The agent the flow uses, as a full agent object (_id, name, ttsModel, llmModel, sttProvider, phoneNumberIds and so on). Use agent._id for the agent's ID. It is null if the flow has no agent.

folderIdobject

The folder the flow is in, as { _id, name, icon, color }, or null.

archivedAtstring

When the flow was archived, or null. An archived flow is read-only: Update Call Flow returns 409 until it is restored in the dashboard.

promptTypestring

simple (one prompt drives the call), nodes (a node-based flow) or flow (legacy).

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 knowledge bases, security and call settings. Update Call Flow describes each one.

knowledgeBasesarray

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

securityobject

Security settings relevant to the call flow.

hipaaComplianceboolean

Indicates whether HIPAA compliance is enabled.

callSettingobject

Call length and silence handling.

maxCallDurationnumber

The longest a call can last, in seconds.

endCallOnSilencenumber

Check in after: seconds of caller silence before the agent checks in to ask if anyone is there. Whole seconds, 5 to 30. It does not end the call by itself; see silenceReminderRetries and endCallAfterReminder on Update Call Flow.

welcomeMessageConfigobject

How the agent opens a call: an Inbound and an Outbound greeting, each with selected, customMessage, aiGreetingPrompt, userFirstFallbackDelaySeconds and userFirstFallbackMessage. Some flows can be missing a direction, a field, or the whole object; a missing selected means aiFirst. Update Call Flow explains each field and how to change it.

Some older flows also return welcomeMessage and customWelcomeMessage, at the top level or inside settings. Nothing reads them; the greeting is welcomeMessageConfig.

If the flow has unpublished changes from the call flow editor, this shows that draft's greeting instead of the live one.

Inboundobject

The greeting for calls received on the flow's phone number.

Outboundobject

The greeting for calls the flow places and for web calls made with the Web SDK.

createdAtstring

Timestamp when the call flow was created.

updatedAtstring

Timestamp when the call flow was last updated.

{
  "_id": "c2c2c2c2c2c2c2c2c2c2c2c2",
  "workspaceId": "c1c1c1c1c1c1c1c1c1c1c1c1",
  "name": "Customer Support Flow",
  "direction": "bidirectional",
  "description": "Handles inbound support calls",
  "agent": {
    "_id": "c3c3c3c3c3c3c3c3c3c3c3c3",
    "name": "Customer Support Flow",
    "phoneNumberIds": []
  },
  "folderId": null,
  "archivedAt": null,
  "promptType": "simple",
  "flowData": {
    "nodes": [],
    "edges": []
  },
  "prompt": "Keep the conversation short and friendly.",
  "isActive": true,
  "settings": {
    "knowledgeBases": [],
    "security": { "hipaaCompliance": false },
    "callSetting": {
      "maxCallDuration": 600,
      "endCallOnSilence": 10,
      "silenceReminderRetries": 1,
      "endCallAfterReminder": 10
    },
    "welcomeMessageConfig": {
      "Inbound": {
        "aiGreetingPrompt": "",
        "customMessage": "Thanks for calling Acme Plumbing, how can I help you?",
        "selected": "customMessage",
        "userFirstFallbackDelaySeconds": 10,
        "userFirstFallbackMessage": ""
      },
      "Outbound": {
        "aiGreetingPrompt": "",
        "customMessage": "",
        "selected": "aiFirst",
        "userFirstFallbackDelaySeconds": 10,
        "userFirstFallbackMessage": ""
      }
    }
  },
  "createdAt": "2025-01-03T11:00:00Z",
  "updatedAt": "2025-01-03T11:10:00Z"
}

Last updated on