Sign in

v64

OpenAPI 3.1.0raw.githubusercontent.com2026-08-01176310978.7 KB
insights.workflows

Activate Insights Workflow

Activate an InsightWorkflow.

put/api/v1/insights/workflows/{workflow_id}/activate

Path parameters

workflow_idinteger required

Request body

is_acknowledgedboolean required

Flag to indicate if the user has acknowledged the estimate

Example request

{
  "is_acknowledged": true,
  "estimate": {
    "backfill_count": 100,
    "backfill_duration": 1000,
    "estimated_daily_count": 10
  }
}

Response

Successful Response

namestring required

Human-readable name of insight workflow

sourcestring required

Source of the workflow

descriptionstring required

Text description of workflow

insight_tool_idsinteger[] required

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

start_datetimestring date-time nullable

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

end_datetimestring date-time nullable

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

idinteger required

Internal ID of the insight workflow

statusstring required

Status of the insight workflow

queue_countinteger nullable

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

failed_countinteger nullable

Number of workflow executions currently in FAILED status

created_atstring date-time

Timestamp at which the insight workflow was created

updated_atstring date-time

Timestamp of most recent update to the insight workflow

last_updated_bystring required

Email of user who last updated Insight Workflow

Example response

{
  "name": "summary-workflow",
  "source": "agent",
  "description": "Default workflow - generates a summary of the call",
  "insight_tool_ids": [
    1
  ],
  "conditions": {
    "min_duration": 120,
    "max_duration": 600,
    "prompt_list": [
      "123324"
    ],
    "folder_list": [
      16754,
      67535
    ],
    "sheet_info": {
      "sheet_id": "1AGOCYz05AZYYOMzow2EYlgdDXSXaWIhyA3-zCxBm4go",
      "sheet_name": "Q1 Sales Data"
    }
  },
  "start_datetime": "2026-07-31T00:00:00Z",
  "end_datetime": "2026-08-01T00:00:00Z",
  "id": 1,
  "insight_tools": [
    {
      "name": "summary-tool",
      "description": "This tool uses GPT4.1 to generate a summary of the call",
      "version": 1,
      "tool_arguments": {
        "prompt": "Provide a concise, accurate summary of the conversation's key points, focusing on the user's goal and how the agent responded"
      },
      "insight_tool_definition_id": 1,
      "id": 1,
      "insight_tool_definition": {
        "id": 1,
        "name": "llm_tool",
        "description": "An LLM tool evaluates a transcript with a given prompt",
        "tool_parameters": {
          "prompt": "string"
        },
        "tool_result_set": {
          "summary": "string"
        }
      },
      "created_at": "2026-07-31T00:00:00Z",
      "updated_at": "2026-08-01T00:00:00Z",
      "last_updated_by": "user@email.com"
    }
  ],
  "status": "ACTIVE",
  "estimate": {
    "backfill_count": 100,
    "backfill_duration": 1000,
    "estimated_daily_count": 10
  },
  "queue_count": 10,
  "failed_count": 2,
  "created_at": "2026-07-31T00:00:00Z",
  "updated_at": "2026-08-01T00:00:00Z",
  "last_updated_by": "user@email.com"
}