Simulate a conversation turn
POST/v1/pathways/simulate
Run one text-simulator turn against exactly one of flow_json (the literal document), pathway_ref ({pathway_id, version_number?}), or agent_ref ({agent_id, version_number?, contact_id?, caller_card?}, which synthesizes the agent's hub flow — the same triage/routing an inbound call runs). The first call (no sim_state) opens the session; later calls echo messages + sim_state with a user_message. Requires an owner-bound key whose owner is an engineer. Authoring payload — passed through from the internal service as-is; it evolves with the product and is not a frozen contract.
Request
Responses
- 200
- 400
- 401
- 403
- 429
- 502
Malformed body (e.g. neither/both of flow_json/pathway_ref).
Missing, invalid, revoked, or expired API key.
The key lacks the pathways:write scope, is not owner-bound, or its owner is not an engineer.
Rate limit exceeded.
The simulator turn failed.