POST
/
api
/
v1
/
insights
/
tools-test
Python (SDK)
import os
from syllable_sdk import SyllableSDK


with SyllableSDK(
    api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:

    res = ss_client.insights.tools.insights_tool_test(request={
        "tool_name": "summary-tool",
        "session_id": 283467,
        "upload_file_id": 283467,
    })

    # Handle response
    print(res)
"<any>"

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

Examples:

"summary-tool"

session_id
integer | null

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

Examples:

"283467"

upload_file_id
integer | null

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

Examples:

"283467"

Response

Successful Response

The response is of type any.