Test Insights Tool

Manually run the given insight tool against a session and return the response.

POST /api/v1/insights/tools-test

Python (SDK)

Python

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",
    })

    # Handle response
    print(res)

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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

200

application/json

Successful Response