POST
/
api
/
v1
/
insights
/
workflows
import os
from syllable_sdk import SyllableSDK


with SyllableSDK(
    api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:

    res = ss_client.insights.workflows.create(request={
        "name": "summary-workflow",
        "description": "Default workflow - generates a summary of the call",
        "insight_tool_ids": [
            1,
        ],
        "conditions": {},
        "status": "ACTIVE",
    })

    # Handle response
    print(res)
{
  "name": "summary-workflow",
  "description": "Default workflow - generates a summary of the call",
  "insight_tool_ids": [
    1
  ],
  "conditions": {
    "trigger": "call_recording"
  },
  "status": "ACTIVE",
  "id": 1,
  "insight_tools": [
    {
      "name": "summary-tool",
      "description": "Default tool - generates 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",
        "type": "<string>",
        "description": "An LLM tool evaluates a transcript with a given prompt",
        "tool_parameters": {
          "prompt": "string"
        },
        "tool_result_set": {
          "summary": "string"
        }
      },
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-02T00:00:00Z",
      "last_updated_by": "user@email.com"
    }
  ],
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-02T00:00:00Z",
  "last_updated_by": "user@email.com"
}

Authorizations

​
Syllable-API-Key
string
header
required

Body

application/json

Request model to create/update an insight workflow.

​
name
string
required

Human-readable name of insight workflow

Example:

"summary-workflow"

​
description
string
required

Text description of insight workflow

Example:

"Default workflow - generates a summary of the call"

​
insight_tool_ids
integer[]
required

List of IDs of insight tools used in the workflow

Example:
[1]
​
conditions
object
required

Conditions for insight workflow to trigger on a given call recording.

Example:
{ "trigger": "call_recording" }
​
status
string
required

Status of the insight workflow

Example:

"ACTIVE"

Response

200
application/json
Successful Response

Response model for an insight workflow.

​
name
string
required

Human-readable name of insight workflow

Example:

"summary-workflow"

​
description
string
required

Text description of insight workflow

Example:

"Default workflow - generates a summary of the call"

​
insight_tool_ids
integer[]
required

List of IDs of insight tools used in the workflow

Example:
[1]
​
conditions
object
required

Conditions for insight workflow to trigger on a given call recording.

Example:
{ "trigger": "call_recording" }
​
status
string
required

Status of the insight workflow

Example:

"ACTIVE"

​
id
integer
required

Internal ID of the insight workflow

Example:

1

​
insight_tools
object[]
required

List of insight tools used in the workflow

Response model for an insight tool.

​
last_updated_by
string
required

Email of user who last updated Insight Workflow

Example:

"user@email.com"

​
created_at
string

Timestamp at which the insight workflow was created

Example:

"2024-01-01T00:00:00Z"

​
updated_at
string

Timestamp of most recent update to the insight workflow

Example:

"2024-01-02T00:00:00Z"