---
title: "Create Insight Workflow"
method: POST
path: "/api/v1/insights/workflows/"
tags: ["insights.workflows"]
---

# Create Insight Workflow

`POST /api/v1/insights/workflows/`

Create a new tool in the insights

## Request body

- InsightWorkflowInput — Request model to create/update an insight workflow.
  - `name` string, required — Human-readable name of insight workflow
  - `source` string, required — Source of the workflow
  - `description` string, required — Text description of workflow
  - `insight_tool_ids` integer[], required — Ordered list of IDs of tool configurations to be executed in the workflow
  - `conditions` InsightWorkflowCondition, required — Model for the conditions that trigger an insight workflow.
    - `min_duration` integer, nullable — Minimum duration of the calls in seconds
    - `max_duration` integer, nullable — Maximum duration of the calls in seconds
    - `sample_rate` union — Sample rate as a percentage of calls
      - integer
      - number
    - `agent_list` union — List of agents
      - integer[]
      - string[]
    - `prompt_list` string[], nullable — List of prompts
    - `folder_list` integer[], nullable — List of folder IDs
    - `sheet_info` object, nullable — Information about the sheet to be used for the workflow
  - `start_datetime` string, date-time, nullable — Target session timestamp the workflow (backfill) should start. An empty value indicates start on activation - live sessions only
  - `end_datetime` string, date-time, nullable — Target session timestamp the workflow (backfill) should end. An empty value indicates no end, i.e., include live sessions until deactivation

## Response `200`

Successful Response

- InsightWorkflowOutput — Response model for an insight workflow.
  - `name` string, required — Human-readable name of insight workflow
  - `source` string, required — Source of the workflow
  - `description` string, required — Text description of workflow
  - `insight_tool_ids` integer[], required — Ordered list of IDs of tool configurations to be executed in the workflow
  - `conditions` InsightWorkflowCondition, required — Model for the conditions that trigger an insight workflow.
    - `min_duration` integer, nullable — Minimum duration of the calls in seconds
    - `max_duration` integer, nullable — Maximum duration of the calls in seconds
    - `sample_rate` union — Sample rate as a percentage of calls
      - integer
      - number
    - `agent_list` union — List of agents
      - integer[]
      - string[]
    - `prompt_list` string[], nullable — List of prompts
    - `folder_list` integer[], nullable — List of folder IDs
    - `sheet_info` object, nullable — Information about the sheet to be used for the workflow
  - `start_datetime` string, date-time, nullable — Target session timestamp the workflow (backfill) should start. An empty value indicates start on activation - live sessions only
  - `end_datetime` string, date-time, nullable — Target session timestamp the workflow (backfill) should end. An empty value indicates no end, i.e., include live sessions until deactivation
  - `id` integer, required — Internal ID of the insight workflow
  - `insight_tools` InsightToolOutput[], required — List of insight tool configurations used in the workflow
    - `name` string, required — Human readable name of insight tool
    - `description` string, required — Text description of insight tool configuration
    - `version` integer, required — Version of insight tool
    - `tool_arguments` unknown, required
    - `insight_tool_definition_id` integer, required — Unique ID for insight tool definition used by this tool configuration
    - `id` integer, required — Unique ID for insight tool
    - `insight_tool_definition` InsightToolDefinition — Model for an insight tool definition. This is a template that can be used by multiple insight tool configurations, each providing their own parameter values.
      - `id` integer, required — Unique ID for insight tool definition
      - `name` string, required — Human-readable name of insight tool definition
      - `type` string, required — Type of insight tool definition
      - `description` string, required — Text description of insight tool definition
      - `tool_parameters` unknown, required
      - `tool_result_set` unknown, required
    - `created_at` string, date-time — Timestamp of at which insight tool configuration was created
    - `updated_at` string, date-time — Timestamp at which insight tool configuration was last updated
    - `last_updated_by` string, required — Email of user who last updated insight tool configuration
  - `status` string, required — Status of the insight workflow
  - `estimate` InsightWorkflowEstimate, required — Response model for an insight workflow.
    - `backfill_count` integer, required — Number of extant calls that will be processed by the workflow
    - `backfill_duration` number, required — Estimated duration of the calls that will be processed by the workflow
    - `estimated_daily_count` integer, required — Estimated number of calls that will be processed by the workflow daily
    - `estimated_daily_duration` number, required — Estimated duration of the calls that will be processed by the workflow daily
    - `estimated_daily_cost` number, required — Estimated cost of the calls that will be processed by the workflow daily
    - `estimated_backfill_cost` number, required — Estimated cost of the backfill of the calls that will be processed by the workflow
  - `queue_count` integer, nullable — Number of calls in the workflow queue (pending or processing)
  - `failed_count` integer, nullable — Number of workflow executions currently in FAILED status
  - `created_at` string, date-time — Timestamp at which the insight workflow was created
  - `updated_at` string, date-time — Timestamp of most recent update to the insight workflow
  - `last_updated_by` string, required — Email of user who last updated Insight Workflow

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/asksyllable/apis/syllablesdk.md) · [All operations](https://skmtc.net/asksyllable/apis/syllablesdk/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/asksyllable/syllablesdk/revisions/534f1f22c775/schema)