POST
/
api
/
v1
/
insights
/
tools
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.tools.create(request={
        "name": "summary-tool",
        "description": "Default tool - generates a summary of the call",
        "version": 1,
        "tool_arguments": {},
        "insight_tool_definition_id": 1,
    })

    # Handle response
    print(res)
{
  "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"
}

Authorizations

​
Syllable-API-Key
string
header
required

Body

application/json

Request model to create/update an insight tool.

​
name
string
required

Human readable name of insight tool

Example:

"summary-tool"

​
description
string
required

Text description of insight tool

Example:

"Default tool - generates a summary of the call"

​
version
integer
required

Version number of insight tool

Example:

1

​
tool_arguments
object
required

Arguments for calling the insight tool

Example:
{
  "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
integer
required

Internal ID for the definition used by the insight tool

Example:

1

Response

200
application/json
Successful Response

Response model for an insight tool.

​
name
string
required

Human readable name of insight tool

Example:

"summary-tool"

​
description
string
required

Text description of insight tool

Example:

"Default tool - generates a summary of the call"

​
version
integer
required

Version of insight tool

Example:

1

​
tool_arguments
object
required

Arguments for calling the insight tool

Example:
{
  "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
integer
required

Unique ID for insight tool definition used by insight tool

Example:

1

​
id
integer
required

Unique ID for insight tool

Example:

1

​
last_updated_by
string
required

Email of user who last updated insight tool

Example:

"user@email.com"

​
insight_tool_definition
object | null

Insight Tool Definition

​
created_at
string

Timestamp of at which insight tool was created

Example:

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

​
updated_at
string

Timestamp at which insight tool was last updated

Example:

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