DocsAPI ReferenceChat/api/v1/chat/room/{id}/message
postChatPublic API v1

/api/v1/chat/room/{id}/message

Append a message to a chat room

chatpostApiV1ChatRoomByIdMessage

Parameters

1 path · 1 query · 8 body

10 total
Path · 1
idstringRequired

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

Length: 2424
Query · 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

Body · 8
contentstringRequired

Message body.

Length: 1
rolestring | string | string | string | string
modelstring
Length: 0100
inputTokensstring | integer
Range: 0
outputTokensstring | integer
Range: 0
toolCallsobject[]

Debug trail of tool invocations for this turn — each entry is one tool call ({ toolCallId, toolName, args, result, state }). Persisted as-is in cas__chat_message.tool_calls (jsonb).

markProblematicboolean

Permanently flag this single message as problematic. Used by ChatSPC when the model calls recordUnansweredQuery — there's no message-level untoggle.

metadataobject

Request

POST /api/v1/chat/room/{id}/message

post
curl -X POST "https://api.bizkithub.com/api/v1/chat/room/ZUiVZuKwAaXNoT4nGUbnKR75/message?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "content": "example_content",
  "model": "example_model",
  "toolCalls": [
    {}
  ],
  "markProblematic": false,
  "metadata": {}
}'

Response

JSON payload

{
  "state": "ok",
  "id": "example_id"
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key