Skip to main content
GET
/
api
/
v1
/
insights
/
tool-definitions
Typescript (SDK)
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();

  console.log(result);
}

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

Authorizations

​
Syllable-API-Key
string
header
required

Response

200 - application/json

Successful Response

​
id
integer
required

Unique ID for insight tool definition

Example:

1

​
name
string
required

Human-readable name of insight tool definition

Example:

"llm_tool"

​
type
string
required

Type of insight tool definition

​
description
string
required

Text description of insight tool definition

Example:

"An LLM tool evaluates a transcript with a given prompt"

​
tool_parameters
any
required

Parameters for tools that use this definition and their associated types

Example:
{ "prompt": "string" }
​
tool_result_set
any
required

Result key/types for insight tool definition

Example:
{ "summary": "string" }