ASasksyllable
insights.tools

List Insight Tool Configurations

Changed on

List the existing insight_tools

get/api/v1/insights/tool-configurations

Request

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

Query parameters

pageinteger nullable

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

limitinteger

The maximum number of items to return

Example:25
search_fieldsInsightToolProperties[]

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

search_field_valuesstring[]

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

order_by'id' | 'name' | 'name_exact' | 'description' | 'tool_arguments' | 'insight_tool_definition_id' | 'updated_at' | 'lifecycle_status'

The field whose value should be used to order the results

order_by_direction'asc' | 'desc'

The direction in which to order list results, either ascending or descending.

The direction in which to order the results

fieldsInsightToolProperties[] nullable

The fields to include in the response

start_datetimestring nullable

The start datetime for filtering results

Example:2023-01-01T00:00:00Z
end_datetimestring nullable

The end datetime for filtering results

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

Response

Successful Response

pageinteger required

The page number of the results (0-based)

page_sizeinteger required

The number of items returned per page

total_pagesinteger nullable

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

total_countinteger nullable

The total number of items returned from the query

Example response

{
  "items": [
    {
      "name": "summary-tool",
      "description": "This tool uses GPT4.1 to generate a summary of the call",
      "version": 1,
      "tool_arguments": {
        "prompt": "Provide a concise, accurate summary of the conversation's key points, focusing on the user's goal and how the agent responded"
      },
      "insight_tool_definition_id": 1,
      "id": 1,
      "insight_tool_definition": {
        "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"
        }
      },
      "created_at": "2026-11-01T00:00:00Z",
      "updated_at": "2026-11-02T00:00:00Z",
      "last_updated_by": "user@email.com"
    }
  ],
  "page_size": 25,
  "total_pages": 4,
  "total_count": 100
}

Changes

  • 778dc4315c56Revision changes
    • info

      added the enum value lifecycle_status to the property anyOf[subschema #1: InsightToolProperties]/ of the query request parameter order_by

    • info

      added the enum value lifecycle_status to the property anyOf[subschema #1]/items/ of the query request parameter fields

    • info

      added the enum value lifecycle_status to the property items/ of the query request parameter search_fields

  • 305657905d18Revision changes
    • info

      added the optional property // to the response with the status