API Reference
API Reference

List Insight Tool Configurations

List the existing insight_tools

GET/api/v1/insights/tool-configurations

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

Query parameters

page integer | null query optional

The page number from which to start (0-based)

Default 0Minimum 0Example 0
limit integer query optional

The maximum number of items to return

Default 25Minimum 0Example 25
search_fields enum<string>[] query optional

String names of fields to search. Correspond by index to search field values

Default []Example name
Item schema
itemsenum<string>required
Allowed values ["id","name","name_exact","description","tool_arguments","insight_tool_definition_id","updated_at"]
search_field_values string[] query optional

Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list

Default []Example Some Object Name
Item schema
itemsstringrequired
order_by enum<string> | null query optional

The field whose value should be used to order the results

Allowed values ["id","name","name_exact","description","tool_arguments","insight_tool_definition_id","updated_at"]Example name
order_by_direction enum<string> | null query optional

The direction in which to order the results

Allowed values ["asc","desc"]
fields enum<string>[] | null query optional

The fields to include in the response

Default []Example []
Item schema
itemsenum<string>required
Allowed values ["id","name","name_exact","description","tool_arguments","insight_tool_definition_id","updated_at"]
start_datetime string | null query optional

The start datetime for filtering results

Example 2023-01-01T00:00:00Z
end_datetime string | null query optional

The end datetime for filtering results

Example 2024-01-01T00:00:00Z

Responses

200Successful Response

application/json

response ListResponse_InsightToolResponse_ required
5 fields
itemsInsightToolResponse[]required

List of items returned from the query

Item schema
itemsInsightToolResponserequired

Response model for insight tool saves, carrying any non-blocking findings.

11 fields
namestringrequired

Human readable name of insight tool

descriptionstringrequired

Text description of insight tool configuration

versionintegerrequired

Version of insight tool

tool_argumentsunspecifiedrequired

Arguments for calling the insight tool

insight_tool_definition_idintegerrequired

Unique ID for insight tool definition used by this tool configuration

idintegerrequired

Unique ID for insight tool

insight_tool_definitionInsightToolDefinition | nulloptional

Insight Tool Definition

6 options
idintegerrequired

Unique ID for insight tool definition

namestringrequired

Human-readable name of insight tool definition

typestringrequired

Type of insight tool definition

descriptionstringrequired

Text description of insight tool definition

tool_parametersunspecifiedrequired

Parameters for tools that use this definition and their associated types

tool_result_setunspecifiedrequired

Result key/types for insight tool definition

created_atstring (date-time)optional

Timestamp of at which insight tool configuration was created

updated_atstring (date-time)optional

Timestamp at which insight tool configuration was last updated

last_updated_bystringrequired

Email of user who last updated insight tool configuration

validation_issuesValidationIssue[] | nulloptional

Non-blocking findings for the saved insight tool (e.g. a deprecated model warning). Warnings and infos are informational; errors block the save.

Item schema
itemsValidationIssuerequired

A single validation finding with severity, location, and description.

5 fields
idstringrequired

Stable machine-readable identifier (kebab-case)

severityenum<string>optional
Allowed values ["info","warning","error"]Default error
messagestringrequired

Human-readable description

pathstring | nulloptional

JSONPath-style location (e.g. $.context.task.steps[2])

valuestring | nulloptional

The offending value, when it adds clarity

pageintegerrequired

The page number of the results (0-based)

page_sizeintegerrequired

The number of items returned per page

total_pagesinteger | nulloptional

The total number of pages of results given the indicated page size

total_countinteger | nulloptional

The total number of items returned from the query

Response example
{
  "items": [
    {
      "name": "string",
      "description": "string",
      "version": 0,
      "tool_arguments": "string",
      "insight_tool_definition_id": 0,
      "id": 0,
      "insight_tool_definition": "string",
      "created_at": "string",
      "updated_at": "string",
      "last_updated_by": "string",
      "validation_issues": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_pages": "string",
  "total_count": "string"
}
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"
    }
  ]
}