/api/v1/chat/ai-turn

Persists both messages in cas__chat_message and returns the answer + ids. Creates the room when roomId is omitted.

chatpostApiV1ChatAi-turn

Parameters

1 query · JSON body

Query parameters

· 1

apiKeystringRequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE

Request body

application/json

questionstringRequired

The user prompt.

Length: 1–∞

roomIdstringOptional

Chat room public id (cas__chat_room.external_id), 24 chars.

Length: 24–24

ExampleZUiVZuKwAaXNoT4nGUbnKR75

modelstringOptional

Length: 0–100

sourcestringOptional

Length: 0–32

externalUserRefstringOptional

Length: 0–64

contactExternalIdstringOptional

Length: 16–16

metadataobjectOptional

Response schema

1 status code documented

200Success

roomIdstringRequired

Chat room public id (cas__chat_room.external_id), 24 chars.

Length: 24–24

ExampleZUiVZuKwAaXNoT4nGUbnKR75

userMessageIdstringRequired

Chat message public id (cas__chat_message.external_id), 24 chars.

Length: 24–24

assistantMessageIdstringRequired

Chat message public id (cas__chat_message.external_id), 24 chars.

Length: 24–24

answerstringRequired

Response example

application/json

{
  "roomId": "ZUiVZuKwAaXNoT4nGUbnKR75",
  "userMessageId": "example_userMessageId",
  "assistantMessageId": "example_assistantMessageId",
  "answer": "example_answer"
}

Request example

POST /api/v1/chat/ai-turn

post

curl -X POST "https://api.bizkithub.com/api/v1/chat/ai-turn?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "question": "example_question",
  "roomId": "ZUiVZuKwAaXNoT4nGUbnKR75",
  "model": "example_model",
  "source": "example_source",
  "externalUserRef": "example_externalUserRef",
  "contactExternalId": "example_contactExternalId",
  "metadata": {}
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key