v64

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01176310978.7 KB

insights.tools

Update Insights Tool Configuration

Update an Insights tool.

put/api/v1/insights/tool-configurations/{tool_id}

Path parameters

tool_idinteger required

Request body

namestring required

Human readable name of insight tool

descriptionstring required

Text description of insight tool configuration

versioninteger required

Version number of insight tool configuration

{"stackTrail":"components:schemas:InsightToolInput:properties:tool_arguments","oasType":"schema","type":"unknown","title":"Tool Arguments","description":"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_idinteger required

Internal ID for the definition used by the insight tool configuration

Example request

{
  "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
}

Response

Successful Response

namestring required

Human readable name of insight tool

descriptionstring required

Text description of insight tool configuration

versioninteger required

Version of insight tool

{"stackTrail":"components:schemas:InsightToolOutput:properties:tool_arguments","oasType":"schema","type":"unknown","title":"Tool Arguments","description":"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_idinteger required

Unique ID for insight tool definition used by this tool configuration

idinteger required

Unique ID for insight tool

created_atstring date-time

Timestamp of at which insight tool configuration was created

updated_atstring date-time

Timestamp at which insight tool configuration was last updated

last_updated_bystring required

Email of user who last updated insight tool configuration

Example response

{
  "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"
}