Status API

🚧

Beta Release

This endpoint is currently in beta and is subject to change. Request and response formats and behavior may change without prior notice.

Verifies the Conversational Assistant is available for your site before starting a session. Only start a session when chatbot.status.enabled is true. A 200 response can still return enabled: false, when the site configuration could not be loaded (disableReason.code CS_001), the chatbot is disabled for the site (CS_004, and the Init API returns 403), or it is not published on the storefront (CS_005). Offer image search only when features.imageSearch.enabled is true.

Query Params
string
required

Site identifier

Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json