Get conversation details

Get the details of a particular conversation

Parámetros de ruta

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

Encabezados

xi-api-keystringOpcional

Parámetros de consulta

formatenumOpcionalValor predeterminado: json

Response format. Defaults to ‘json’. Set to ‘opentelemetry’ for an OTLP-compatible trace payload using the same structure as the post-call webhook.

Valores permitidos:

Respuesta

Successful Response
agent_idstring
statusenum
Valores permitidos:
metadataobject
conversation_idstring
has_audioboolean
has_user_audioboolean
has_response_audioboolean
has_auxiliary_audioboolean
transcriptlist of objects
agent_namestringOpcional
conversation_productstringOpcionalValor predeterminado: agent
user_idstringOpcional
branch_idstringOpcional
version_idstringOpcional
The ID of the agent version used for this conversation
analysisobjectOpcional
visited_agentslist of objectsOpcional
conversation_initiation_client_dataobjectOpcional
environmentstringOpcionalValor predeterminado: production
tag_idslist of stringsOpcional
Conversation tag ids assigned to this conversation.
otlp_tracesmap from strings to anyOpcional

OpenTelemetry trace payload when the request uses format=opentelemetry; otherwise omitted.

Errores

422
Conversations Get Request Unprocessable Entity Error