Voxli Voxli

Test Results

Add conversation message

Add a message, tool call, or event to the test result conversation.

Types:

  • message — chatbot text response (requires content)
  • tool — tool call record (requires name)
  • internal-event — only used during assertions, not visible to the conversation agent (requires name)
  • public-event — event visible to both conversation and scoring agents (requires name)

Returns the recorded entry, including the id that addresses it later.

POST /test-results/{id}/conversation

Authorization

HeaderTypeDescription
Authorizationrequired
string
Header with your API key as a Bearer token: Bearer <api-key>. See Authentication.

Path parameters

NameTypeDescription
idrequired
string
ID of the test result

Body

application/json
PropertyTypeDescription
type
enum<string>
Message type: 'message' for text content, 'tool' for tool calls, 'internal-event' for events only visible to the scoring agent, 'public-event' for events visible in conversation history.
Allowed values: message, tool, internal-event, public-event, actionDefault: "message"
content
string
Text content of the message. Required when type is 'message'.
name
string
Name of the tool or event. Required when type is 'tool', 'internal-event', or 'public-event'.
metadata
object
Optional user-defined metadata (max 100KB). Can contain any JSON-serializable data.
after
string
ID of an existing conversation message to insert this entry after. Mutually exclusive with 'before'. Omit both to append at the end.
before
string
ID of an existing conversation message to insert this entry before. Mutually exclusive with 'after'. Omit both to append at the end.

Response

  • 201Successful Response
PropertyTypeDescription
id
string
Server-generated identifier used to address this message, e.g. when attaching metadata after the fact.
role
enum<string>
user is the simulated user (Voxli's tester), assistant the agent under test.
Allowed values: user, assistantDefault: "assistant"
type
enum<string>
Allowed values: message, tool, internal-event, public-event, actionDefault: "message"
content
string
name
string
metadata
object
Optional user-defined metadata for tool calls. Can contain any JSON-serializable data (max 100KB).
createdAt
string (date-time)
UTC time the message was added to the conversation.

Test Results

Generate next message