v64

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

insights.tools

Get Insight Tool Definitions

Get a InsightTool by Name.

get/api/v1/insights/tool-definitions

Response

Successful Response

idinteger required

Unique ID for insight tool definition

namestring required

Human-readable name of insight tool definition

typestring required

Type of insight tool definition

descriptionstring required

Text description of insight tool definition

{"stackTrail":"components:schemas:InsightToolDefinition:properties:tool_parameters","oasType":"schema","type":"unknown","title":"Tool Parameters","description":"Parameters for tools that use this definition and their associated types","example":{"prompt":"string"}}

{"stackTrail":"components:schemas:InsightToolDefinition:properties:tool_result_set","oasType":"schema","type":"unknown","title":"Tool Result Set","description":"Result key/types for insight tool definition","example":{"summary":"string"}}

Example response

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