GET
/
api
/
v1
/
insights
/
tool-definitions
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.insightToolGetDefinitions();

  // Handle the result
  console.log(result);
}

run();
[
  {
    "id": 123,
    "name": "<string>",
    "type": "<string>",
    "description": "<string>",
    "tool_parameters": {},
    "tool_result_set": {}
  }
]

Authorizations

Syllable-API-Key
string
header
required

Response

200 - application/json
Successful Response
id
integer
required

Unique ID for Insight Tool Definition

name
string
required

Human readable name of Insight Tool Definition

type
string
required

Type of Insight Tool Definition

description
string
required

Text description of Insight Tool Definition

tool_parameters
object
required

Parameters for Insight Tool Definition

tool_result_set
object
required

Result key/types for Insight Tool Definition