Skip to main content
PUT
Typescript (SDK)

Authorizations

Syllable-API-Key
string
header
required

Path Parameters

workflow_id
integer
required

Body

application/json

Request model to activate an insight workflow.

is_acknowledged
boolean
required

Flag to indicate if the user has acknowledged the estimate

Example:

true

estimate
InsightWorkflowEstimate · object
required

Estimate of the number of calls that will be processed by the workflow

Response

Successful Response

Response model for an insight workflow.

name
string
required

Human-readable name of insight workflow

Example:

"summary-workflow"

source
string
required

Source of the workflow

Examples:

"agent"

"transfer"

"upload"

"sheet"

"manual"

description
string
required

Text description of workflow

Example:

"Default workflow - generates a summary of the call"

insight_tool_ids
integer[]
required

Ordered list of IDs of tool configurations to be executed in the workflow

Example:
conditions
InsightWorkflowCondition · object
required

Conditions (filters) on which a workflow should be triggered.

id
integer
required

Internal ID of the insight workflow

Example:

1

insight_tools
InsightToolOutput · object[]
required

List of insight tool configurations used in the workflow

status
string
required

Status of the insight workflow

Examples:

"ACTIVE"

"INACTIVE"

estimate
InsightWorkflowEstimate · object
required

Estimate of the number of calls that will be processed by the workflow and their cost

last_updated_by
string
required

Email of user who last updated Insight Workflow

Example:

"user@email.com"

start_datetime
string<date-time> | null

Target session timestamp the workflow (backfill) should start. An empty value indicates start on activation - live sessions only

Example:

"2026-07-21T00:00:00Z"

end_datetime
string<date-time> | null

Target session timestamp the workflow (backfill) should end. An empty value indicates no end, i.e., include live sessions until deactivation

Example:

"2026-07-22T00:00:00Z"

queue_count
integer | null

Number of calls in the workflow queue (pending or processing)

Example:

10

failed_count
integer | null

Number of workflow executions currently in FAILED status

Example:

2

created_at
string<date-time>

Timestamp at which the insight workflow was created

Example:

"2026-07-21T00:00:00Z"

updated_at
string<date-time>

Timestamp of most recent update to the insight workflow

Example:

"2026-07-22T00:00:00Z"