Voxli Voxli

Test Results

Generate next message

Generate the next message from the tester.

Polling Behavior: This endpoint may return ready: false if the next message is not yet available. When this happens, wait briefly (e.g., 1-2 seconds) and call this endpoint again until ready: true is returned.

Workflow:

  1. Call next-message for the first tester turn. If your bot greets first, record that greeting through conversation before polling.
  2. If ready: false, wait and retry next-message.
  3. If end_chat: true, the conversation has ended. Automatic completion queues scoring; manual completion requires finish after all conversation writes.
  4. Otherwise, send message to your bot or apply action in your system. Voxli has already recorded the tester's turn.
  5. Record the bot's replies, tools, and events through conversation in their original order. Put tool output before the reply that uses it.
  6. Repeat from step 1 until the conversation ends.
POST /test-results/{id}/next-message

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

Response

  • 200Successful Response
PropertyTypeDescription
message
string
The next message from the tester. Will be null if ready is false, or when the tester invokes an action instead.
action
object
The action the tester chose to invoke this turn, if any. Mutually exclusive with message. Only populated when the chatbot's most recent turn registered invokable actions via event metadata.
namerequired
string
Name of the action being invoked.
arguments
object
Argument values matching the action's declared properties.
end_chatrequired
boolean
Whether the test conversation should end after this message.
readyrequired
boolean
Whether the message is ready. If false, wait and poll this endpoint again until ready is true.
message_id
string
Server-generated ID of the conversation entry recorded for this turn (the tester's message or action). Null when end_chat is true or ready is false.

Test Results

Finish test result