Create or resume an active widget chat conversation, optionally with its first message

POST

/widget/chat/conversations

When body or attachments are provided, the conversation and first visitor message are persisted transactionally. Omitting them preserves the legacy create-or-resume response.

Authorizations

BearerAuth

JWT token from login

Type

HTTP (bearer)

or

AccessToken

Personal access token. Value: Token <your-token>

Type

API Key (header: Authorization)

Request Body

application/json

{

  

"body": "string",

  

"attachments": [

  

  

{

  

  

}

  

],

  

"page": {

  

},

  

"metadata": {

  

}

}

Responses

Created

Content-Type

application/json

{

  

"conversation": "string",

  

"message": "string",

  

"ai": {

  

},

  

"routing": "string"

}

POST

/widget/chat/conversations

Playground

Authorization

BearerAuth

Body

Samples

Powered by VitePress OpenAPI