Conversations
Import a conversation
Stores a chat with your agent, in OpenTelemetry's GenAI messages format, keyed by your agent's own id for the chat. Importing the same id again replaces that conversation's messages. Traces with the same chat id are linked: ones sent to Voxli, and ones Voxli reads from a connected Langfuse or LangSmith shortly after the import.
POST
/conversations/ Authorization
HeaderTypeDescription
Authorizationrequiredstring
Header with your API key as a Bearer token:
Bearer <api-key>. See Authentication.Body
application/jsonPropertyTypeDescription
externalIdrequiredstring
Your agent's own id for this chat. Importing the same id again replaces the conversation.
messagesrequiredobject[]The chat in order, in OpenTelemetry's GenAI messages format: what the user and your agent said, and the tools your agent called
messagesrequiredThe chat in order, in OpenTelemetry's GenAI messages format: what the user and your agent said, and the tools your agent called
rolerequiredenum<string>
user for the person chatting, assistant for your agent, tool for what a tool returned
Allowed values: user, assistant, toolpartsrequiredobject[]The message's parts in order: text, tool calls on an assistant message, and tool call responses on a tool message
partsrequiredThe message's parts in order: text, tool calls on an assistant message, and tool call responses on a tool message
If type is "text"object
type is "text"typerequiredstring
Value:
"text"contentrequiredstring
The text
If type is "tool_call"object
type is "tool_call"typerequiredstring
Value:
"tool_call"idrequiredstring
The call's id. Its response has it too.
namerequiredstring
The tool's name
argumentsany
The arguments, as any JSON
If type is "tool_call_response"object
type is "tool_call_response"typerequiredstring
Value:
"tool_call_response"idrequiredstring
The id of the tool call it answers
responserequiredany
What the tool returned, as any JSON
timestampstring (date-time)
When it was sent, in UTC. Not part of OpenTelemetry's format.
startedAtstring (date-time)
When the chat started, in UTC. Without it, the first message's timestamp, or the time of the import.
metadataobject
Any JSON to keep with the conversation, such as a channel. Importing the chat again without it keeps the earlier metadata.
Response
- 200The chat was imported before; its messages were replaced
- 201A new conversation
PropertyTypeDescription
idrequiredstring
The conversation's id in Voxli
Traces
Send traces (OTLP/HTTP)