embed v1

Api Instant Search

post/v1/instant_search

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/instant_search
  • Auth: none declared

Headers

Originstring nullable
x-api-keystring nullable

Request body

session_idstring required
navigator_idstring required
embed_type'chat' | 'search' | 'chat_widget' | 'search_interface' | 'voice' | 'api' | 'form'
querystring required
localestring required
urlstring uri nullable

Response

Successful Response

scorenumber required
vertex_idstring required
chunk_idstring required
highlightstring required
titlestring required
localestring required
label'entry' | 'content' | 'contact' | 'tool' | 'fallback' | 'integration' | 'style' | 'chat_navigator_style' | 'search_style' | 'search_result' | 'navigator' | 'feedback' required
sourcestring nullable
custom_metadataobject
html_element_idstring nullable

Changes

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