Skip to main content
POST
Runs a simulated Rulebook evaluation directly from a flowConfig payload. Use this for draft builders, preview tools, or CI checks that need to test an unsaved rule tree.

Headers

string
required
Bearer token containing your Fini workspace API key. Format: Bearer fini_... The key needs read scope.
string
required
application/json

Body parameters

object
required
Rulebook flow configuration to run.
object
Synthetic input fields for the rule evaluation.
object
Synthetic runtime fields such as provider, channel, or agent context.
string
Generated path ID being run.
string
Node ID the simulation should end on.
array
Optional simulated conversation history. Each item can include role, type, content, event_id, and metadata.content.
boolean
Whether to mock LLM extraction nodes during simulation.

Response

Returns a rule test path run result.