API Reference
API Reference

Test Insights Tool

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

POST/api/v1/insights/tools-test

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

This endpoint has no declared parameters.

Request body

application/json

body InsightToolTestInput required
3 fields
tool_namestringrequired

Human readable name of insight tool configuration

session_idinteger | nulloptional

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

upload_file_idinteger | nulloptional

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

Request example
{
  "tool_name": "string",
  "session_id": "string",
  "upload_file_id": "string"
}

Responses

200Successful Response

application/json

response unspecified required
Response example
string
400Bad Request

No response body is declared.

404Not Found

No response body is declared.

422Validation Error

application/json

response HTTPValidationError required
1 field
detailValidationError[]optional
Item schema
itemsValidationErrorrequired
3 fields
locstring | integer[]required
Item schema
itemsstring | integerrequired
2 options
Option 1stringrequired
Option 2integerrequired
msgstringrequired
typestringrequired
Response example
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
500Internal Server Error

No response body is declared.