Init 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.

Creates a new chat session. The response contains a chatSessionId, which must be passed to all subsequent calls, and a sessionEndTime. Chat sessions remain valid for 24 hours from the time they are created.

Returns HTTP 403 with CS_004 when the feature is disabled in configuration, and HTTP 429 with CS_002 when the site's session quota is used up.

Query Params
string
required

Site identifier

Body Params

Init chat request payload

string
searchConfig
object
string
required
length ≄ 1
Responses

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