SoulFire LogoSoulFire

Submit dialog

Submits a dialog with input values. Used for dialogs containing text fields, checkboxes, dropdowns, or sliders. The dialog is closed after submission. Note: Full dialog response packets are not yet implemented; this clears local state.

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

Submits a dialog with input values. Used for dialogs containing text fields, checkboxes, dropdowns, or sliders. The dialog is closed after submission. Note: Full dialog response packets are not yet implemented; this clears local 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 submitting the dialog.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

input_values*array<>

Map of input key to value for each input field. Keys must match the key field of DialogInput elements.

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:submit" \  -H "Content-Type: application/json" \  -d '{    "input_values": [      {}    ]  }'
{  "success": true,  "error": "string"}

How is this page?