BizKitHub Developer Documentation

Parameters

1 path · 1 query

Path parameters

· 1

idstringRequired

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

Length: 24–24

ExampleZUiVZuKwAaXNoT4nGUbnKR75

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

Response schema

1 status code documented

200Success

object | object

One of 2:

Variant 1

state"ok"Required

roomobjectRequired

idstringRequired

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

Length: 24–24

ExampleZUiVZuKwAaXNoT4nGUbnKR75

kind"ai" | "internal" | "external"Required

titlestringRequired

sourcestring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

modelstring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

ownerContactExternalIdstring | nullRequired

One of 2:

Variant 1

string

16-char shop__contact.external_id of the logged-in customer who owns this thread. Null for anonymous threads and member-owned (internal) threads.

Variant 2

null

ownerContactNamestring | nullRequired

One of 2:

Variant 1

string

Display name of the owning contact (first_name + last_name, or company_name as fallback). Null when no owner is set or when the contact has no name fields filled.

Variant 2

null

externalUserRefstring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

messageCountstring | integerRequired

One of 2:

Variant 1

stringinteger

Default: 0

Variant 2

integer

totalTokensstring | integerRequired

One of 2:

Variant 1

stringinteger

Default: 0

Variant 2

integer

lastMessageDatestring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

isMarkedProblematicbooleanRequired

True when the conversation is flagged as a problem case (toggleable).

hasProblematicMessagebooleanRequired

True when at least one message in the thread is marked problematic.

insertedDatestringRequired

updatedDatestringRequired

metadataobjectRequired

messagesobject[]Required

Each array item:

idstringRequired

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

Length: 24–24

positionstring | integerRequired

One of 2:

Variant 1

stringinteger

Default: 0

Variant 2

integer

role"user" | "assistant" | "system" | "tool" | "member"Required

contentstringRequired

modelstring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

inputTokensstring | integer | nullRequired

One of 2:

Variant 1

string | integer

One of 2:

Variant 1

stringinteger

Default: 0

Variant 2

integer

Variant 2

null

outputTokensstring | integer | nullRequired

One of 2:

Variant 1

string | integer

One of 2:

Variant 1

stringinteger

Default: 0

Variant 2

integer

Variant 2

null

toolCallsobject[] | nullRequired

One of 2:

Variant 1

object[]

Each array item:

object

Variant 2

null

isMarkedProblematicbooleanRequired

True when this single turn is flagged problematic (permanent — no untoggle).

insertedDatestringRequired

metadataobjectRequired

Variant 2

state"error"Required

messagestringRequired

code"200"Required

Response example

application/json

{
  "state": "ok",
  "room": {
    "id": "ZUiVZuKwAaXNoT4nGUbnKR75",
    "title": "example_title",
    "isMarkedProblematic": false,
    "hasProblematicMessage": false,
    "insertedDate": "example_insertedDate",
    "updatedDate": "example_updatedDate",
    "metadata": {}
  },
  "messages": [
    {
      "id": "example_id",
      "content": "example_content",
      "isMarkedProblematic": false,
      "insertedDate": "example_insertedDate",
      "metadata": {}
    }
  ]
}

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

Parameters

Path parameters

Query parameters

Response schema

Response example

Request example

Need an API key?