POST/ai/chats/create

Create an empty AI chat

Creates an empty AI chat for the authenticated user. Use this operation to start a conversation before sending a message; AI must be included in the current licence and enabled for chat.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 status codes
200Returns the created chat in the response payload.
dataobjectoptional
statusintegeroptional
successbooleanoptional
403Returned when the authenticated user is forbidden, AI is not included in the current licence, or AI chat is disabled.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 403 is returned when the authenticated user is forbidden, AI is not included in the current licence, or AI chat is disabled. Confirm that AI is enabled for the workspace licence and that chat access is permitted.