API Reference
API Reference

Events List

GET/api/v1/events/

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 ["timestamp","session_id","conversation_id","source","source_id","category","type","user_id","description","attributes"]
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 ["timestamp","session_id","conversation_id","source","source_id","category","type","user_id","description","attributes"]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 ["timestamp","session_id","conversation_id","source","source_id","category","type","user_id","description","attributes"]
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_Event_ required
5 fields
itemsEvent[]required

List of items returned from the query

Item schema
itemsEventrequired

An event represents a specific occurrence during a session.

10 fields
timestampstring (date-time)required

Timestamp at which the event occurred

session_idstring | nulloptional

ID of the session in which the event occurred

conversation_idstring | nulloptional

ID of the conversation associated with the session in which the event occurred

sourcestring | nulloptional

Source of the event (either a tool call or an LLM prompt)

source_idstring | nulloptional

ID of the source of the event (either a tool ID or a prompt ID)

categorystring | nulloptional

Broad categorization of the event

typestring | nulloptional

More specific class of the event

user_idstring | nulloptional

ID of the user interacting with the system when the event occurred (e.g., their phone number)

descriptionstring | nulloptional

Human-readable description of the event

attributesobject | nulloptional

Arbitrary additional metadata for the event

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": [
    {
      "timestamp": "string",
      "session_id": "string",
      "conversation_id": "string",
      "source": "string",
      "source_id": "string",
      "category": "string",
      "type": "string",
      "user_id": "string",
      "description": "string",
      "attributes": "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"
    }
  ]
}