API Reference
API Reference

Get Session Data By Session Id

GET/api/v1/session_debug/session_id/{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 integer path required

Responses

200Successful Response

application/json

response SessionData required
5 fields
session_idintegerrequired

Session ID

sourcestringrequired

Session source

targetstringrequired

Session target

is_testbooleanrequired

Is test session

messagesSessionMessage[]required

Session messages

Item schema
itemsSessionMessagerequired
4 fields
roleenum<string>required

Dialog role

Allowed values ["agent","user"]
dialogDialogMessagerequired

Dialog message

1 field
textstringrequired

Dialog message text

tool_callsDialogToolCall[]required

Tool calls

Item schema
itemsDialogToolCallrequired
6 fields
tool_call_idstringrequired

Tool call ID

tool_namestringrequired

Tool name

tool_argumentsunspecifiedrequired

Tool arguments

tool_resultunspecified | nullrequired

Tool result data (only included if tool has propagate_tool_result=true)

display_resultunspecified | nulloptional

Display-only presentation data for this tool result

timestampstring (date-time)required

Tool call timestamp

timestampstring (date-time)required

Message timestamp

Response example
{
  "session_id": 0,
  "source": "string",
  "target": "string",
  "is_test": true,
  "messages": [
    {
      "role": "string",
      "dialog": {
        "text": "string"
      },
      "tool_calls": [
        {
          "tool_call_id": "string",
          "tool_name": "string",
          "tool_arguments": "string",
          "tool_result": "string",
          "display_result": "string",
          "timestamp": "string"
        }
      ],
      "timestamp": "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"
    }
  ]
}