embed v1

Api Process Form Route Request

post/v1/embed/form/route

Request

  • Base URL: https://api.branchly.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.branchly.io/v1/embed/form/route
  • Auth: none declared

Headers

x-api-keystring nullable

Request body

application_idstring uuid required
session_idstring uuid required
embed_type'chat' | 'search' | 'chat_widget' | 'search_interface' | 'voice' | 'api' | 'form' required
localestring required
browser_localestring nullable
urlstring uri nullable
previous_answerstring required

The answer from step 1 (form/init) that the user deemed insufficient.

querystring

Synthetic query representing the user's intent to submit a form.

Response

Successful Response

messagestring required

Agent's explanation of why this form was chosen.

Changes

No recorded changes to this operation across all 1 revision of this API.