Skip to main content
POST
/
api
/
v1
/
insights
/
tools-test
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.insightsToolTest({
    toolName: "summary-tool",
  });

  console.log(result);
}

run();
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.syllable.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Syllable-API-Key
string
header
required

Body

application/json

Request model to test an insight tool.

​
tool_name
string
required

Human readable name of insight tool configuration

Example:

"summary-tool"

​
session_id
integer | null

The session ID of the session against which to run the tool

Example:

"283467"

​
upload_file_id
integer | null

The file ID of the uploaded file against which to run the tool

Example:

"283467"

Response

Successful Response