ASasksyllable
insights.tools

Get Insight Tool Definitions

Get a InsightTool by Name.

get/api/v1/insights/tool-definitions

Request

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

Response

Successful Response

idinteger required

Unique ID for insight tool definition

namestring required

Human-readable name of insight tool definition

typestring required

Type of insight tool definition

descriptionstring required

Text description of insight tool definition

tool_parametersunknown required
tool_result_setunknown required

Example response

[
  {
    "id": 1,
    "name": "llm_tool",
    "description": "An LLM tool evaluates a transcript with a given prompt",
    "tool_parameters": {
      "prompt": "string"
    },
    "tool_result_set": {
      "summary": "string"
    }
  }
]

Changes

No operation changes recorded.