Sign in

v66

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-04176310979.2 KB
insights.workflows

Insight Workflow List

List the existing insight_workflows

get/api/v1/insights/workflows/

Query parameters

pageinteger nullable

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

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

limitinteger

The maximum number of items to return

Example:25

The maximum number of items to return

search_fieldsInsightWorkflowProperties[]

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

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

search_field_valuesstring[]

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

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

order_by'id' | 'name' | 'name_exact' | 'description' | 'status' | 'conditions' | 'insight_tool_ids' | 'updated_at'

The field whose value should be used to order the results

order_by_direction'asc' | 'desc'

The direction in which to order list results, either ascending or descending.

The direction in which to order the results

fieldsInsightWorkflowProperties[] nullable

The fields to include in the response

The fields to include in the response

start_datetimestring nullable

The start datetime for filtering results

Example:2023-01-01T00:00:00Z

The start datetime for filtering results

end_datetimestring nullable

The end datetime for filtering results

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

The end datetime for filtering results

Response

Successful Response

pageinteger required

The page number of the results (0-based)

page_sizeinteger required

The number of items returned per page

total_pagesinteger nullable

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

total_countinteger nullable

The total number of items returned from the query

Example response

{
  "items": [
    {
      "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-08-03T00:00:00Z",
      "end_datetime": "2026-08-04T00: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-08-03T00:00:00Z",
          "updated_at": "2026-08-04T00: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-08-03T00:00:00Z",
      "updated_at": "2026-08-04T00:00:00Z",
      "last_updated_by": "user@email.com"
    }
  ],
  "page_size": 25,
  "total_pages": 4,
  "total_count": 100
}