API Reference
API Reference

Conversations List

GET/api/v1/conversations/

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","agent_type","agent_id","agent_name","prompt_id","prompt_name","llm_provider","llm_model","llm_version","is_legacy"]
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","agent_type","agent_id","agent_name","prompt_id","prompt_name","llm_provider","llm_model","llm_version","is_legacy"]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","agent_type","agent_id","agent_name","prompt_id","prompt_name","llm_provider","llm_model","llm_version","is_legacy"]
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_Conversation_ required
5 fields
itemsConversation[]required

List of items returned from the query

Item schema
itemsConversationrequired

A conversation is a record of messages between a user and an agent, and is composed of one or more sessions.

14 fields
timestampstring (date-time)required

Timestamp of the conversation

conversation_idstringrequired

ID of the conversation

agent_idstring | nulloptional

ID of the agent with which the conversation occurred

agent_namestring | nulloptional

Name of the agent with which the conversation occurred

agent_typestring | nulloptional

Value of the "type" field of the agent with which the conversation occurred

prompt_idstring | nulloptional

ID of the prompt used in the conversation

prompt_namestring | nulloptional

Name of the prompt used in the conversation

prompt_versionstring | nulloptional

Version of the prompt used in the conversation

llm_providerstring | nulloptional

Provider for the LLM used in the conversation (see PromptResponse.llm_config.provider)

llm_modelstring | nulloptional

Model for the LLM used in the conversation (see PromptResponse.llm_config.model)

llm_versionstring | nulloptional

Version for the LLM used in the conversation (see PromptResponse.llm_config.version)

llm_temperaturenumber | nulloptional

Temperature for the LLM used in the conversation (see PromptResponse.llm_config.temperature)

llm_seedinteger | nulloptional

Seed for the LLM used in the conversation (see PromptResponse.llm_config.seed).

is_legacyboolean | nulloptional

Whether the conversation occurred on the legacy Syllable system

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",
      "conversation_id": "string",
      "agent_id": "string",
      "agent_name": "string",
      "agent_type": "string",
      "prompt_id": "string",
      "prompt_name": "string",
      "prompt_version": "string",
      "llm_provider": "string",
      "llm_model": "string",
      "llm_version": "string",
      "llm_temperature": "string",
      "llm_seed": "string",
      "is_legacy": "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"
    }
  ]
}