POST
/
api
/
v1
/
insights
/
tools
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.create({
    name: "<value>",
    description: "yuck vice between gee ugh ha",
    version: 920994,
    toolArguments: {},
    insightToolDefinitionId: 780486,
  });

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

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

Authorizations

Syllable-API-Key
string
header
required

Body

application/json
name
string
required

Human readable name of Insight Tool

description
string
required

Text description of Insight Tool

version
integer
required

Version number of Insight Tool

tool_arguments
object
required

Arguments for Insight Tool

insight_tool_definition_id
integer
required

Unique ID for Insight Tool Definition

Response

200
application/json
Successful Response
name
string
required

Human readable name of Insight Tool

description
string
required

Text description of Insight Tool

version
integer
required

Version of Insight Tool

tool_arguments
object
required

Arguments for Insight Tool

insight_tool_definition_id
integer
required

Unique ID for Insight Tool Definition

id
integer
required

Unique ID for Insight Tool

last_updated_by
string
required

User who last updated Insight Tool

insight_tool_definition
object | null

Insight Tool Definition

created_at
string

Timestamp of Insight Tool creation

updated_at
string

Timestamp of Insight Tool update