Voiceflow bearer token
Conversation state
Inspect and reset test conversations.
See Authentication for credentials and permissions.
Returns the stored state for one conversation - where it stands and what its variables hold - addressed by the same userID used to run it.
Authentication
Path parameters
The ID identifying this conversation. Any stable string you choose; the same value addresses the same conversation on every call.
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Which version of the environment to read: the editable draft or the published one.
draft, publishedResponse
Returns the user's session state for the requested version of the environment: every variable and its current value, the runtime storage carried between turns, and the execution stack showing which diagram and node the conversation is sitting on.
Changes the stored state of a live conversation, which is how a caller seeds or corrects variables between turns without replaying the conversation.
Authentication
Voiceflow bearer token
Path parameters
The ID identifying this conversation. Any stable string you choose; the same value addresses the same conversation on every call.
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Which version of the environment to read: the editable draft or the published one.
draft, publishedRequest body
The execution stack for the conversation, from root to innermost frame.
Internal runtime storage persisted across turns of the session.
The current values of the agent variables for this session.
Response
Confirms the conversation state was written for that user. The body carries a message only, so fetch the state again to see the stack, storage, and variables as they now stand.
A human-readable message confirming the update.
Discards the stored state for one conversation, so the next turn on that userID begins from the start. The response carries only a confirmation message.
Authentication
Voiceflow bearer token
Path parameters
The ID identifying this conversation. Any stable string you choose; the same value addresses the same conversation on every call.
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Which version of the environment to read: the editable draft or the published one.
draft, publishedResponse
Confirms the user's stored state was deleted. The body is a message only, so nothing of the discarded stack, storage, or variables comes back with it.
A human-readable message confirming the deletion.
Updates variables in the conversation state by merging with the properties in the request body.
Authentication
Voiceflow bearer token
Path parameters
The ID identifying this conversation. Any stable string you choose; the same value addresses the same conversation on every call.
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Which version of the environment to read: the editable draft or the published one.
draft, publishedRequest body
Variable values to set on the conversation session, keyed by variable name.
Response
Confirms the supplied variables were merged into the session's existing values. The response is a message only, so read the state back if you need the merged result.
A human-readable message confirming the update.