SoulFire LogoSoulFire

Close dialog

Closes/dismisses the current dialog. Clears the local dialog state.

POST
/v1/instances/p0/bots/p1/dialog:close

Closes/dismisses the current dialog. Clears the local dialog state.

Authorization

AuthorizationBearer <token>

Preferred API authentication. Use a JWT with the api audience.

In: header

Path Parameters

instance_id*string

The UUID of the SoulFire instance containing the bot.

Formatuuid
bot_id*string

The profile UUID of the bot to close dialog for.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://127.0.0.1:38765/v1/instances/p0/bots/p1/dialog:close"
{  "success": true,  "error": "string"}

How is this page?