Get Insight Tool Config By Id

Get a InsightTool by Name.

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

Typescript (SDK)

TypeScript

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.insights.tools.getById({
    toolId: "<id>",
  });

  console.log(result);
}

run();

200

{
  "name": "<string>",
  "description": "<string>",
  "version": 123,
  "tool_arguments": "<unknown>",
  "insight_tool_definition_id": 123,
  "id": 123,
  "last_updated_by": "<string>",
  "insight_tool_definition": {
    "id": 123,
    "name": "<string>",
    "type": "<string>",
    "description": "<string>",
    "tool_parameters": "<unknown>",
    "tool_result_set": "<unknown>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Syllable-API-Key · string · header · required

Path Parameters

tool_id · string · required

Response

200

application/json

Successful Response

Response model for an insight tool configuration.

name · string · required

Human readable name of insight tool

Example:

"summary-tool"

description · string · required

Text description of insight tool configuration

Example:

"This tool uses GPT4.1 to generate a summary of the call"

version · integer · required

Version of insight tool

Example:

1

tool_arguments · any · 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 this tool configuration

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 configuration

Example:

"[e-mail]"

insight_tool_definition · InsightToolDefinition · object

Insight Tool Definition

Show child attributes

created_at · string<date-time>

Timestamp of at which insight tool configuration was created

Example:

"2026-05-27T00:00:00Z"

updated_at · string<date-time>

Timestamp at which insight tool configuration was last updated

Example:

"2026-05-28T00:00:00Z"