Get Conversation Details

Get the details of a particular conversation

Headers

xi-api-key

string

Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

Path Parameters

conversation_id

string

required

The id of the conversation you're taking the action on.

Response

200 - application/json

agent_id

string

required

conversation_id

string

required

status

enum<string>

required

Available options:

processing,

done

transcript

object[]

required

Show child attributes

transcript.role

enum<string>

required

Available options:

user,

agent

transcript.message

string

transcript.tool_calls

object[]

Show child attributes

transcript.tool_calls.request_id

string

required

transcript.tool_calls.tool_name

string

required

transcript.tool_calls.params_as_json

string

required

transcript.tool_calls.tool_has_been_called

boolean

required

transcript.tool_results

object[]

Show child attributes

transcript.tool_results.request_id

string

required

transcript.tool_results.tool_name

string

required

transcript.tool_results.result_value

string

required

transcript.tool_results.is_error

boolean

required

transcript.tool_results.tool_has_been_called

boolean

required

transcript.feedback

object

Show child attributes

transcript.feedback.score

enum<string>

required

An enumeration.

Available options:

like,

dislike

transcript.feedback.time_in_call_secs

integer

required

transcript.time_in_call_secs

integer

required

transcript.conversation_turn_metrics

object

metadata

object

required

Show child attributes

metadata.start_time_unix_secs

integer

required

metadata.call_duration_secs

integer

required

metadata.cost

integer

metadata.feedback

object

Show child attributes

metadata.feedback.overall_score

enum<string>

An enumeration.

Available options:

like,

dislike

metadata.feedback.likes

integer

default: 0

metadata.feedback.dislikes

integer

default: 0

metadata.authorization_method

enum<string>

default: public

An enumeration.

Available options:

public,

authorization_header,

signed_url,

shareable_link

metadata.charging

object

Show child attributes

metadata.charging.dev_discount

boolean

default: false

analysis

object

Show child attributes

analysis.call_successful

enum<string>

required

An enumeration.

Available options:

success,

failure,

unknown

analysis.transcript_summary

string

required

analysis.evaluation_criteria_results

object

Show child attributes

analysis.evaluation_criteria_results.{key}

object

Show child attributes

analysis.evaluation_criteria_results.{key}.criteria_id

string

required

analysis.evaluation_criteria_results.{key}.result

enum<string>

required

An enumeration.

Available options:

success,

failure,

unknown

analysis.evaluation_criteria_results.{key}.rationale

string

required

analysis.data_collection_results

object

Show child attributes

analysis.data_collection_results.{key}

object

Show child attributes

analysis.data_collection_results.{key}.data_collection_id

string

required

analysis.data_collection_results.{key}.rationale

string

required

analysis.data_collection_results.{key}.value

any

analysis.data_collection_results.{key}.json_schema

object

Show child attributes

analysis.data_collection_results.{key}.json_schema.type

enum<string>

required

Available options:

boolean,

string,

integer,

number

analysis.data_collection_results.{key}.json_schema.description

string

required

conversation_initiation_client_data

object

Show child attributes

conversation_initiation_client_data.conversation_config_override

object

Show child attributes

conversation_initiation_client_data.conversation_config_override.agent

object

Show child attributes

conversation_initiation_client_data.conversation_config_override.agent.prompt

object

Show child attributes

conversation_initiation_client_data.conversation_config_override.agent.prompt.prompt

string

default:

conversation_initiation_client_data.conversation_config_override.agent.first_message

string

conversation_initiation_client_data.conversation_config_override.agent.language

string

conversation_initiation_client_data.conversation_config_override.tts

object

Show child attributes

conversation_initiation_client_data.conversation_config_override.tts.voice_id

string

conversation_initiation_client_data.custom_llm_extra_body

object