API Reference
API Reference

Inspect Latency For Session

GET/api/v1/sessions/latency/{session_id}

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

Path parameters

session_id string path required

Responses

200Successful Response

application/json

response InspectLatencyResponse required
3 fields
session_idstringrequired
timelineLatencyEntry[]required
Item schema
itemsLatencyEntryrequired

Data model for latency entries.

9 fields
timestampstring (date-time)required
measurement_startstring (date-time)required
categoryenum<string>required
Allowed values ["tts","stt","llm","tool","http"]
labelstringrequired
metadatastring[] | nulloptional
Item schema
itemsstringrequired
unit_typeenum<string>required
Allowed values ["minutes","seconds","milliseconds","microseconds","nanoseconds"]
valuenumberrequired
value_strstringrequired
time_deltastringrequired
summarySummaryEntry[]optional
Item schema
itemsSummaryEntryrequired

A summary entry is an aggregation of latency entries by category and sub-category. It contains the total and average latency for each category.

7 fields
categoryenum<string>reference defined above
Allowed values ["tts","stt","llm","tool","http"]
sub_categorystring | nulloptional
event_countintegerrequired
sum_msnumberrequired
sum_strstringrequired
average_msnumberrequired
average_strstringrequired
Response example
{
  "session_id": "string",
  "timeline": [
    {
      "timestamp": "string",
      "measurement_start": "string",
      "category": "string",
      "label": "string",
      "metadata": "string",
      "unit_type": "string",
      "value": 0,
      "value_str": "string",
      "time_delta": "string"
    }
  ],
  "summary": [
    {
      "category": null,
      "sub_category": "string",
      "event_count": 0,
      "sum_ms": 0,
      "sum_str": "string",
      "average_ms": 0,
      "average_str": "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"
    }
  ]
}