Skip to main content
POST
Simulate a walk through the dialogue graph

Path Parameters

graph_id
string
required

Body

application/json

Body for POST /dialogues/{id}/simulate.

The simulator walks the graph, taking the choices specified. variables seeds the variable state; choices is a sequence of branch indices (0-based) to take when a choice node is reached. Missing choices default to branches[0] (the first branch).

variables
Variables · object
choices
integer[]

Sequence of branch indices to take when reaching a choice node.

max_steps
integer
default:100

Hard cap on transitions; prevents infinite loops in cyclic graphs.

Required range: 1 <= x <= 500

Response

Simulation transcript

Response for POST /dialogues/{id}/simulate.

terminated_reason
string
required

Why the simulation stopped. One of: end_node, max_steps, no_branches, choice_index_out_of_range, no_start_node.

transcript
DialogueSimulateStep · object[]
final_variables
Final Variables · object