GET
/
v1
/
{account_id}
/
{project_id}
/
conversations

Authorizations

x-api-key
string
headerrequired

Path Parameters

account_id
string
required

Account ID

project_id
string
required

Project ID

Query Parameters

client_env
enum<string>
default: live

Client Environment - sandbox, pre-release or live

Available options:
sandbox,
pre-release,
live
start_time
string

The start of the time range of the conversations to get, in ISO8601 format

end_time
string

The end of the time range of the conversations to get, in ISO8601 format

limit
integer
default: 5

Max number of conversations to return per API call. If the result set of your query is larger than this, it will be paginated.

offset
integer
default: 0

Offset within result set to fetch.

include_context_state
boolean
default: false

If true, include the context_state for each conversation. This is a large, noisy dictionary of the agent's internal dialogue state at the end of the conversation.

variant_id
string

If it is set, we would return all conversations under this variant_id. Note that you may only specify either one of the variant_id or variant_name

variant_name
string

If it is set, we would return all conversations under this variant_name. Note that you may only specify either one of the variant_id or variant_name. Also, make sure to encode any spaces in the name with "%20"

in_progress
boolean

If it is set to false, we only return finished conversations. If it is set to true, we only return conversations still in progress. By default, this parameter is None and we return all conversations

Response

200 - application/json
conversations
object[]

An array of conversations returned in ascending chronological order.

descriptions
object

An dictionary of response keys and their descriptions

next_offset
integer

If present, the result is being paginated and requires another API call to fetch the next portion (pass the provided next_offset as the offset param for the next API call).