API Reference
API Reference

Insight Workflow List

List the existing insight_workflows

GET/api/v1/insights/workflows/

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

Query parameters

page integer | null query optional

The page number from which to start (0-based)

Default 0Minimum 0Example 0
limit integer query optional

The maximum number of items to return

Default 25Minimum 0Example 25
search_fields enum<string>[] query optional

String names of fields to search. Correspond by index to search field values

Default []Example name
Item schema
itemsenum<string>required
Allowed values ["id","name","name_exact","description","status","conditions","insight_tool_ids","updated_at"]
search_field_values string[] query optional

Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list

Default []Example Some Object Name
Item schema
itemsstringrequired
order_by enum<string> | null query optional

The field whose value should be used to order the results

Allowed values ["id","name","name_exact","description","status","conditions","insight_tool_ids","updated_at"]Example name
order_by_direction enum<string> | null query optional

The direction in which to order the results

Allowed values ["asc","desc"]
fields enum<string>[] | null query optional

The fields to include in the response

Default []Example []
Item schema
itemsenum<string>required
Allowed values ["id","name","name_exact","description","status","conditions","insight_tool_ids","updated_at"]
start_datetime string | null query optional

The start datetime for filtering results

Example 2023-01-01T00:00:00Z
end_datetime string | null query optional

The end datetime for filtering results

Example 2024-01-01T00:00:00Z

Responses

200Successful Response

application/json

response ListResponse_InsightWorkflowOutput_ required
5 fields
itemsInsightWorkflowOutput[]required

List of items returned from the query

Item schema
itemsInsightWorkflowOutputrequired

Response model for an insight workflow.

17 fields
namestringrequired

Human-readable name of insight workflow

sourcestringrequired

Source of the workflow

descriptionstringrequired

Text description of workflow

insight_tool_idsinteger[]required

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

Item schema
itemsintegerrequired
conditionsInsightWorkflowConditionrequired

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

7 fields
min_durationinteger | nulloptional

Minimum duration of the calls in seconds

max_durationinteger | nulloptional

Maximum duration of the calls in seconds

sample_rateinteger | number | nulloptional

Sample rate as a percentage of calls

3 options
Option 1integeroptional
Option 2numberoptional
Option 3nulloptional
agent_listinteger[] | string[] | nulloptional

List of agents

Item schema
Option 1integer[]optional
Item schema
itemsintegerrequired
Option 2string[]optional
Item schema
itemsstringrequired
Option 3nulloptional
prompt_liststring[] | nulloptional

List of prompts

Item schema
itemsstringrequired
folder_listinteger[] | nulloptional

List of folder IDs

Item schema
itemsintegerrequired
sheet_infoobject | nulloptional

Information about the sheet to be used for the workflow

1 options
{key}stringoptional
start_datetimestring (date-time) | nulloptional

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

end_datetimestring (date-time) | nulloptional

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

idintegerrequired

Internal ID of the insight workflow

insight_toolsInsightToolOutput[]required

List of insight tool configurations used in the workflow

Item schema
itemsInsightToolOutputrequired

Response model for an insight tool configuration.

10 fields
namestringrequired

Human readable name of insight tool

descriptionstringrequired

Text description of insight tool configuration

versionintegerrequired

Version of insight tool

tool_argumentsunspecifiedrequired

Arguments for calling the insight tool

insight_tool_definition_idintegerrequired

Unique ID for insight tool definition used by this tool configuration

idintegerrequired

Unique ID for insight tool

insight_tool_definitionInsightToolDefinition | nulloptional

Insight Tool Definition

6 options
idintegerrequired

Unique ID for insight tool definition

namestringrequired

Human-readable name of insight tool definition

typestringrequired

Type of insight tool definition

descriptionstringrequired

Text description of insight tool definition

tool_parametersunspecifiedrequired

Parameters for tools that use this definition and their associated types

tool_result_setunspecifiedrequired

Result key/types for insight tool definition

created_atstring (date-time)optional

Timestamp of at which insight tool configuration was created

updated_atstring (date-time)optional

Timestamp at which insight tool configuration was last updated

last_updated_bystringrequired

Email of user who last updated insight tool configuration

statusstringrequired

Status of the insight workflow

estimateInsightWorkflowEstimaterequired

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

6 fields
backfill_countintegerrequired

Number of extant calls that will be processed by the workflow

backfill_durationnumberrequired

Estimated duration of the calls that will be processed by the workflow

estimated_daily_countintegerrequired

Estimated number of calls that will be processed by the workflow daily

estimated_daily_durationnumberrequired

Estimated duration of the calls that will be processed by the workflow daily

estimated_daily_costnumberrequired

Estimated cost of the calls that will be processed by the workflow daily

estimated_backfill_costnumberrequired

Estimated cost of the backfill of the calls that will be processed by the workflow

queue_countinteger | nulloptional

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

failed_countinteger | nulloptional

Number of workflow executions currently in FAILED status

created_atstring (date-time)optional

Timestamp at which the insight workflow was created

updated_atstring (date-time)optional

Timestamp of most recent update to the insight workflow

last_updated_bystringrequired

Email of user who last updated Insight Workflow

last_folder_upload_atstring (date-time) | nulloptional

Timestamp 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)

pageintegerrequired

The page number of the results (0-based)

page_sizeintegerrequired

The number of items returned per page

total_pagesinteger | nulloptional

The total number of pages of results given the indicated page size

total_countinteger | nulloptional

The total number of items returned from the query

Response example
{
  "items": [
    {
      "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",
        "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"
        }
      ],
      "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"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_pages": "string",
  "total_count": "string"
}
422Validation Error

application/json

response HTTPValidationError required
1 field
detailValidationError[]optional
Item schema
itemsValidationErrorrequired
3 fields
locstring | integer[]required
Item schema
itemsstring | integerrequired
2 options
Option 1stringrequired
Option 2integerrequired
msgstringrequired
typestringrequired
Response example
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}