API reference
Flows API
Scripted conversation paths that run alongside grounded answers: create and edit a flow, walk it with canned answers, publish it, and see where visitors stop.
Endpoints
7 operations, each with its parameters, schemas and an example request on its own page.
- get/api/flowsList flows
- post/api/flowsCreate flow
- put/api/flows/{flow_id}Update flow
- delete/api/flows/{flow_id}Delete flow
- get/api/flows/{flow_id}/analyticsFlow analytics — Where visitors stop.
- post/api/flows/{flow_id}/publishPublish flow — Makes the draft the version visitors walk through.
- post/api/flows/{flow_id}/simulateSimulate flow — Walks a flow with canned answers. Changes nothing.
Authentication
Every call here needs Authorization: Bearer with a key from the dashboard — Authentication covers keys and scopes.
Objects returned
The models these endpoints send back, with every field. Open one to read it.
Message2 fields
messagestringrequiredokbooleanDefault: true
Something here wrong or missing? Tell us — the documentation and the API are maintained by the same person, so a correction is a fix rather than a ticket.