/api/chat1

Send a chat query and receive a (bot) response. The Bot configuration is part of the backend setup.

Parameters

(string) question
(string) alternatively to q, a chat command, one of 'archive', 'delete', 'flag'.
(string) chat session number. Usually maintained by the server side session if the web session id is provided🔗 chat_sid
(string) guests, with the ShopSetup altcha on: the solved ALTCHA payload (see api/client/altcha), needed with the question that opens a chat session. Without it the call fails with error CAPTCHA; too many guest questions fail with LIMIT
(String) optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml
(int) optionally force the API to check against the role (instead of silently not returning data). For guests or public access, the default is -1. 0 (regular customer) and above define the role for which the current session is expected to be authorized.

Response Types

ChatControl ยท ChatResponse

ChatControl (v1) docs

Chat service availability status

Fields (1)
#FieldTypeDescription
0statusintcontrol status code: -2=chat(bot) disabled in this system or not open for the current user, 0=offline, 1=online (control only), 2=OK - a ChatResponse with the answer follows

Data (1 record)

status
2

ChatResponse (v1) docs

A chat bot response message or a message in a chat transcript.

Fields (6)
#FieldTypeDescriptionLinks
0sidstringchat session id. Usually maintained in the server side session.⬆ sid🔗 chat_sid
1speechstringtext response from the chat bot, intended for speech output
2displaystringdisplay-ready HTML response. While the content should be similar to the speech output, the format may be different, depending on the chat provider.
3actionstringmicroformat action string, handled by the client. E.g. [g:123] is a advice to the client to show items or a link to item group 123.
4dtdatetimemessage timestamp, time of generation
5agentstringagent name, set for bot answers, empty for user messages

Data (1 record)

sidspeechdisplayactiondtagent
e288f7da-6787-4579-80f8-6@schoenegge →chatscript1 →chat1 ⬆2026-11-22T16:02:37+0100