ASasksyllable
insights.tools

Test Insights Tool

Changed on

Run the saved tool against one session or uploaded file without persisting insights.

post/api/v1/insights/tools-test

Request

  • Base URL
    https://api.syllable.cloud
  • URL
    https://api.syllable.cloud/api/v1/insights/tools-test
  • Auth
    API key in header Syllable-API-Key

Request body

tool_namestring required

Human readable name of insight tool configuration

Example request

{
  "tool_name": "summary-tool"
}

Response

Successful Response

unknown required

Changes

  • 1b623f11737fRevision changes
    • breaking

      the response's body type changed from object to no type for status

  • edf75e19d2efRevision changes
    • breaking

      the request property's minLength was increased from 0 to 1

    • breaking

      added the pattern \S to the request property

    • breaking

      the response's body type changed from no type to object for status

    • info

      request property list-of-types was widened by adding types string to media type application/json

    • info

      request property list-of-types was widened by adding types string to media type application/json

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status