Get Insight Workflow By Id
Get a InsightWorkflow by ID.
/api/v1/insights/workflows/{workflow_id}Authentication
Syllable-API-KeyrequiredSend Syllable-API-Key in the header.
Need a credential? Create or manage an API token in the Syllable Console.
Parameters
Path parameters
workflow_id
integer
path
required
Responses
200Successful Response
application/json
response
InsightWorkflowResponse
required
20 fields
format_versionenum<integer>optionalWorkflow configuration format version
[1,2]Default 1revisioninteger | nulloptionalExpected saved revision when updating a workflow
0stepsInsightWorkflowStep[] | nulloptionalOrdered steps with stable identities for version 2 workflows
100Item schema
itemsInsightWorkflowSteprequired4 fields
step_idstringrequired1Maximum length 128Pattern ^[A-Za-z0-9_-]+$insight_tool_idintegerrequired0conditionsInsightToolConditionGroup | nulloptional2 options
matchenum<string>optional["all","any"]Default allrulesInsightConditionRule[]optional50Item schema
itemsInsightConditionRulerequired5 fields
rule_idstringrequired1Maximum length 128Pattern ^[A-Za-z0-9_-]+$sourceSessionConditionSource | TranscriptConditionSource | ToolConditionSource | InsightConditionSourcerequired4 options
Option 1SessionConditionSourcerequired1 field
kindstringrequiredsessionOption 2TranscriptConditionSourcerequired2 fields
kindstringrequiredtranscriptstep_idstring | nulloptional1Maximum length 128Pattern ^[A-Za-z0-9_-]+$Option 3ToolConditionSourcerequired2 fields
kindstringrequiredtooltool_namestringrequired1Maximum length 255Pattern \SOption 4InsightConditionSourcerequired3 fields
kindstringrequiredinsightstep_idstringrequired1Maximum length 128Pattern ^[A-Za-z0-9_-]+$keystringrequired1Maximum length 512fieldstring | nulloptional64operatorenum<string> | nulloptional["eq","neq","in","not_in","gte","lte","between","contains","not_contains","is_empty","is_not_empty"]valueunspecifiedoptionaltranscript_source_step_idstring | nulloptional1Maximum length 128Pattern ^[A-Za-z0-9_-]+$namestringrequiredHuman-readable name of insight workflow
sourcestringrequiredSource of the workflow
descriptionstringrequiredText description of workflow
insight_tool_idsinteger[]requiredOrdered list of IDs of tool configurations to be executed in the workflow
Item schema
itemsintegerrequiredconditionsInsightWorkflowConditionrequiredConditions (filters) on which a workflow should be triggered.
9 fields
min_durationinteger | nulloptionalMinimum duration of the calls in seconds
max_durationinteger | nulloptionalMaximum duration of the calls in seconds
sample_rateinteger | number | nulloptionalSample rate as a percentage of calls
3 options
Option 1integeroptionalOption 2numberoptionalOption 3nulloptionalagent_listinteger[] | string[] | nulloptionalList of agents
Item schema
Option 1integer[]optionalItem schema
itemsintegerrequiredOption 2string[]optionalItem schema
itemsstringrequiredOption 3nulloptionalprompt_liststring[] | nulloptionalList of prompts
Item schema
itemsstringrequiredagent_labelsstring[] | nulloptionalMatch any of these labels on the session agent in its current state. Combined with other conditions using AND; an empty list applies no filter.
Item schema
itemsstringrequiredprompt_labelsstring[] | nulloptionalMatch any of these labels on the prompt version used by the session. Combined with other conditions using AND; an empty list applies no filter.
Item schema
itemsstringrequiredfolder_listinteger[] | nulloptionalList of folder IDs
Item schema
itemsintegerrequiredsheet_infoobject | nulloptionalLegacy sheet metadata, retained for viewing retired workflows
1 options
{key}stringoptionalstart_datetimestring (date-time) | nulloptionalTarget session timestamp the workflow (backfill) should start. An empty value indicates start on activation - live sessions only
end_datetimestring (date-time) | nulloptionalTarget session timestamp the workflow (backfill) should end. An empty value indicates no end, i.e., include live sessions until deactivation
idintegerrequiredInternal ID of the insight workflow
insight_toolsInsightToolResponse[]requiredOrdered tool configurations, including model lifecycle findings
Item schema
itemsInsightToolResponserequiredResponse model for insight tool saves, carrying any non-blocking findings.
11 fields
namestringrequiredHuman readable name of insight tool
descriptionstringrequiredText description of insight tool configuration
versionintegerrequiredVersion of insight tool
tool_argumentsunspecifiedrequiredArguments for calling the insight tool. LLM tools carry their configuration in llm_config. Its optional integer seed is deprecated by Syllable and should be left unset for new configurations. Seed does not guarantee identical responses; support depends on provider, model and endpoint. OpenAI/Azure Responses and Anthropic sampling do not support seed. Configured values (including zero) produce nonblocking llm-seed-deprecated findings at $.tool_arguments.llm_config.seed in configuration responses. Unset/null values do not. Saved values do not establish past request handling.
insight_tool_definition_idintegerrequiredUnique ID for insight tool definition used by this tool configuration
idintegerrequiredUnique ID for insight tool
insight_tool_definitionInsightToolDefinition | nulloptionalInsight Tool Definition
6 options
idintegerrequiredUnique ID for insight tool definition
namestringrequiredHuman-readable name of insight tool definition
typestringrequiredType of insight tool definition
descriptionstringrequiredText description of insight tool definition
tool_parametersunspecifiedrequiredParameters for tools that use this definition and their associated types
tool_result_setunspecifiedrequiredResult key/types for insight tool definition
created_atstring (date-time)optionalTimestamp of at which insight tool configuration was created
updated_atstring (date-time)optionalTimestamp at which insight tool configuration was last updated
last_updated_bystringrequiredEmail of user who last updated insight tool configuration
validation_issuesValidationIssue[] | nulloptionalCurrent findings for the saved insight tool. Configured seed (including zero) returns llm-seed-deprecated at $.tool_arguments.llm_config.seed; unset/null seed does not. Known Anthropic seed restrictions are reported separately as llm-seed-unsupported. Seed warnings do not block saves or establish past request handling. Model lifecycle findings are also included; retired models block saves but can appear on reads. Explicitly projected lists can omit findings; their absence does not establish that seed is unset or supported.
Item schema
itemsValidationIssuerequiredA single validation finding with severity, location, and description.
5 fields
idstringrequiredStable machine-readable identifier (kebab-case)
severityenum<string>optional["info","warning","error"]Default errormessagestringrequiredHuman-readable description
pathstring | nulloptionalJSONPath-style location (e.g. $.context.task.steps[2])
valuestring | nulloptionalThe offending value, when it adds clarity
statusstringrequiredStatus of the insight workflow
estimateInsightWorkflowEstimaterequiredEstimate of the number of calls that will be processed by the workflow and their cost
6 fields
backfill_countintegerrequiredNumber of extant calls that will be processed by the workflow
backfill_durationnumberrequiredEstimated duration of the calls that will be processed by the workflow
estimated_daily_countintegerrequiredEstimated number of calls that will be processed by the workflow daily
estimated_daily_durationnumberrequiredEstimated duration of the calls that will be processed by the workflow daily
estimated_daily_costnumberrequiredEstimated cost of the calls that will be processed by the workflow daily
estimated_backfill_costnumberrequiredEstimated cost of the backfill of the calls that will be processed by the workflow
queue_countinteger | nulloptionalNumber of calls in the workflow queue (pending or processing)
failed_countinteger | nulloptionalNumber of workflow executions currently in FAILED status
created_atstring (date-time)optionalTimestamp at which the insight workflow was created
updated_atstring (date-time)optionalTimestamp of most recent update to the insight workflow
last_updated_bystringrequiredEmail of user who last updated Insight Workflow
last_folder_upload_atstring (date-time) | nulloptionalTimestamp of the most recent file upload to any folder associated with this workflow (null for non-upload workflows or until a file has been uploaded)
Response example
{
"format_version": 1,
"revision": "string",
"steps": "string",
"name": "string",
"source": "string",
"description": "string",
"insight_tool_ids": [
0
],
"conditions": {
"min_duration": "string",
"max_duration": "string",
"sample_rate": "string",
"agent_list": "string",
"prompt_list": "string",
"agent_labels": "string",
"prompt_labels": "string",
"folder_list": "string",
"sheet_info": "string"
},
"start_datetime": "string",
"end_datetime": "string",
"id": 0,
"insight_tools": [
{
"name": "string",
"description": "string",
"version": 0,
"tool_arguments": "string",
"insight_tool_definition_id": 0,
"id": 0,
"insight_tool_definition": "string",
"created_at": "string",
"updated_at": "string",
"last_updated_by": "string",
"validation_issues": "string"
}
],
"status": "string",
"estimate": {
"backfill_count": 0,
"backfill_duration": 0,
"estimated_daily_count": 0,
"estimated_daily_duration": 0,
"estimated_daily_cost": 0,
"estimated_backfill_cost": 0
},
"queue_count": "string",
"failed_count": "string",
"created_at": "string",
"updated_at": "string",
"last_updated_by": "string",
"last_folder_upload_at": "string"
}422Validation Error
application/json
response
HTTPValidationError
required
1 field
detailValidationError[]optionalItem schema
itemsValidationErrorrequired3 fields
locstring | integer[]requiredItem schema
itemsstring | integerrequired2 options
Option 1stringrequiredOption 2integerrequiredmsgstringrequiredtypestringrequiredResponse example
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}
