Skip to main content
POST
Simulate a bot flow turn

Authorizations

api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

id
integer
required

The numeric ID of the bot flow.

Example:

1

Body

application/json
graph
object

The graph to run. Omit to use the flow's published graph.

state
object

Where the simulated conversation currently is. Send the state from the previous response to continue.

message
string

What the contact says on this turn.

Example:

"Billing"

Response

Success

transcript
object[]

What was said on this turn, each entry with a role and text.

state
object

The state after this turn. Send it back on the next call to continue the simulation.

status
string

Whether the flow is still running or has finished.