API Reference
API Reference

Get Insight Tool Definitions

Get a InsightTool by Name.

GET/api/v1/insights/tool-definitions

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

This endpoint has no declared parameters.

Responses

200Successful Response

application/json

response InsightToolDefinition[] required
Item schema
itemsInsightToolDefinitionrequired

Model for an insight tool definition. This is a template that can be used by multiple insight tool configurations, each providing their own parameter values.

6 fields
idintegerrequired

Unique ID for insight tool definition

namestringrequired

Human-readable name of insight tool definition

typestringrequired

Type of insight tool definition

descriptionstringrequired

Text description of insight tool definition

tool_parametersunspecifiedrequired

Parameters for tools that use this definition and their associated types

tool_result_setunspecifiedrequired

Result key/types for insight tool definition

Response example
[
  {
    "id": 0,
    "name": "string",
    "type": "string",
    "description": "string",
    "tool_parameters": "string",
    "tool_result_set": "string"
  }
]