Syllable Insights API
Operations related to insights results. An insight is a tool that processes conversation data to extract information and generate reports.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/syllable-insights-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: SyllableSDK Insights API
description: '# Syllable Platform SDK
Syllable SDK gives you the power of awesome AI agentry.'
version: 0.0.3
servers:
- url: https://api.syllable.cloud
description: API server
tags:
- name: Insights
description: Operations related to insights results. An insight is a tool that processes conversation data to extract information and generate reports.
paths:
/api/v1/insights/:
get:
tags:
- Insights
summary: Insights List
description: List the evaluated insights for sessions.
operationId: insights_list
security:
- APIKeyHeader: []
parameters:
- name: page
in: query
required: false
schema:
anyOf:
- type: integer
minimum: 0
- type: 'null'
description: The page number from which to start (0-based)
examples:
- 0
default: 0
title: Page
description: The page number from which to start (0-based)
- name: limit
in: query
required: false
schema:
type: integer
minimum: 0
description: The maximum number of items to return
examples:
- 25
default: 25
title: Limit
description: The maximum number of items to return
- name: search_fields
in: query
required: false
schema:
type: array
items:
$ref: '#/components/schemas/InsightsProperties'
description: String names of fields to search. Correspond by index to search field values
examples:
- name
default: []
title: Search Fields
description: String names of fields to search. Correspond by index to search field values
- name: search_field_values
in: query
required: false
schema:
type: array
items:
type: string
description: 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
examples:
- Some Object Name
default: []
title: Search Field Values
description: 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
- name: order_by
in: query
required: false
schema:
anyOf:
- $ref: '#/components/schemas/InsightsProperties'
- type: 'null'
description: The field whose value should be used to order the results
examples:
- name
title: Order By
description: The field whose value should be used to order the results
- name: order_by_direction
in: query
required: false
schema:
anyOf:
- $ref: '#/components/schemas/OrderByDirection'
- type: 'null'
description: The direction in which to order the results
title: Order By Direction
description: The direction in which to order the results
- name: fields
in: query
required: false
schema:
anyOf:
- type: array
items:
$ref: '#/components/schemas/InsightsProperties'
- type: 'null'
description: The fields to include in the response
default: []
title: Fields
description: The fields to include in the response
- name: start_datetime
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: The start datetime for filtering results
examples:
- '2023-01-01T00:00:00Z'
title: Start Datetime
description: The start datetime for filtering results
- name: end_datetime
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: The end datetime for filtering results
examples:
- '2024-01-01T00:00:00Z'
title: End Datetime
description: The end datetime for filtering results
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ListResponse_InsightsOutput_'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-codeSamples:
- lang: python
label: Python (SDK)
source: "import os\nfrom syllable_sdk import SyllableSDK, models\n\n\nwith SyllableSDK(\n api_key_header=os.getenv(\"SYLLABLESDK_API_KEY_HEADER\", \"\"),\n) as ss_client:\n\n res = ss_client.insights.list(page=0, limit=25, search_fields=[\n models.InsightsProperties.UPLOAD_FILE_ID,\n ], search_field_values=[\n \"Some Object Name\",\n ], start_datetime=\"2023-01-01T00:00:00Z\", end_datetime=\"2024-01-01T00:00:00Z\")\n\n # Handle response\n print(res)"
- lang: typescript
label: Typescript (SDK)
source: "import { SyllableSDK } from \"syllable-sdk\";\n\nconst syllableSDK = new SyllableSDK({\n apiKeyHeader: process.env[\"SYLLABLESDK_API_KEY_HEADER\"] ?? \"\",\n});\n\nasync function run() {\n const result = await syllableSDK.insights.list({\n page: 0,\n searchFields: [\n \"upload_file_id\",\n ],\n searchFieldValues: [\n \"Some Object Name\",\n ],\n startDatetime: \"2023-01-01T00:00:00Z\",\n endDatetime: \"2024-01-01T00:00:00Z\",\n });\n\n console.log(result);\n}\n\nrun();"
components:
schemas:
InsightsOutput:
properties:
id:
type: integer
title: Id
description: Unique ID of the insight
examples:
- 1
session_id:
anyOf:
- type: integer
- type: 'null'
title: Session Id
description: Unique ID for the session
examples:
- 12341
upload_file_id:
anyOf:
- type: integer
- type: 'null'
title: Upload File Id
description: Unique ID for uploaded file
examples:
- 12535
insight_tool_id:
type: integer
title: Insight Tool Id
description: Unique ID for insight tool configuration
examples:
- 34531
insight_tool_version:
type: integer
title: Insight Tool Version
description: Version of insight tool configuration
examples:
- 1
workflow_id:
anyOf:
- type: integer
- type: 'null'
title: Workflow Id
description: Insight workflow that produced this row, if applicable
examples:
- 42
insight_key:
type: string
title: Insight Key
description: Key for insight tool result
examples:
- summary
string_value:
anyOf:
- type: string
- type: 'null'
title: String Value
description: String value of insight tool result
examples:
- This is a summary of the call
numeric_value:
anyOf:
- type: number
- type: 'null'
title: Numeric Value
description: Numeric value of insight tool result
examples:
- 1.0
json_value:
additionalProperties:
anyOf:
- type: string
- type: integer
- type: number
type: object
title: Json Value
description: JSON value of insight tool result
examples:
- content: ' was there anything else that I can assist you with other than this'
role: assistant
start_time: 289
created_at:
type: string
format: date-time
title: Created At
description: Timestamp at which insight tool result was created
examples:
- '2026-08-04T00:00:00Z'
updated_at:
type: string
format: date-time
title: Updated At
description: Timestamp at which insight tool result was last updated
examples:
- '2026-08-05T00:00:00Z'
upload_file_metadata:
title: Upload File Metadata
description: Metadata associated with the uploaded file
examples:
- duration: 00:10:00
size: 10MB
type: object
required:
- id
- insight_tool_id
- insight_tool_version
- insight_key
- json_value
title: InsightsOutput
description: Response model for an insight tool.
InsightsProperties:
type: string
enum:
- id
- session_id
- upload_file_id
- workflow_id
- upload_folder_id
- insight_key
- insight_tool_id
title: InsightsProperties
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError
ListResponse_InsightsOutput_:
properties:
items:
items:
$ref: '#/components/schemas/InsightsOutput'
type: array
title: Items
description: List of items returned from the query
examples: []
page:
type: integer
title: Page
description: The page number of the results (0-based)
examples:
- 0
page_size:
type: integer
title: Page Size
description: The number of items returned per page
examples:
- 25
total_pages:
anyOf:
- type: integer
- type: 'null'
title: Total Pages
description: The total number of pages of results given the indicated page size
examples:
- 4
total_count:
anyOf:
- type: integer
- type: 'null'
title: Total Count
description: The total number of items returned from the query
examples:
- 100
type: object
required:
- items
- page
- page_size
title: ListResponse[InsightsOutput]
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
OrderByDirection:
type: string
enum:
- asc
- desc
title: OrderByDirection
description: The direction in which to order list results, either ascending or descending.
securitySchemes:
APIKeyHeader:
type: apiKey
in: header
name: Syllable-API-Key
x-speakeasy-name-override:
- operationId: .*_list$
methodNameOverride: list
- operationId: .*_create$
methodNameOverride: create
- operationId: .*_update$
methodNameOverride: update
- operationId: .*_upload$
methodNameOverride: upload
- operationId: .*_delete$
methodNameOverride: delete
- operationId: .*_get_by_id$
methodNameOverride: get_by_id
- operationId: .*_get_by_name$
methodNameOverride: get_by_name
- operationId: .*_add$
methodNameOverride: add
- operationId: .*_remove$
methodNameOverride: remove
- operationId: .*_results$
methodNameOverride: results
- operationId: .*_queue_work$
methodNameOverride: queue_work
- operationId: .*_activate$
methodNameOverride: activate
- operationId: .*_inactivate$
methodNameOverride: inactivate
- operationId: .*_list_files$
methodNameOverride: list_files
- operationId: .*_move_files$
methodNameOverride: move_files
- operationId: .*_upload_file$
methodNameOverride: upload_file