Public API

Chat

3 endpoints.

GET/api/v1/public/chat/config

Webchat config for the calling site (gates the widget)

Parameters

Name	In	Type	Description
`X-API-Key`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_dict_str__Any__

Field Type Description

request_idrequired string

success true default true

datarequired object

metadata

ResponseMetadata | null

ResponseMetadata fields

Field Type Description

pagination

PaginationMetadata | null

PaginationMetadata fields

Field	Type	Description
`limit`required	`integer`
`next_cursor`	`string \| null`
`prev_cursor`	`string \| null`
`has_more`required	`boolean`
`has_prev`	`boolean`	default false
`total_count`	`integer \| null`

status_counts

object | null

object | null fields

Map of string to integer

lifecycle_counts

LifecycleCounts | null

LifecycleCounts fields

Field	Type	Description
`lead`	`integer`	default 0
`prospect`	`integer`	default 0
`customer`	`integer`	default 0
`former_customer`	`integer`	default 0

classification_counts

ClassificationCounts | null

ClassificationCounts fields

Field	Type	Description
`signal`	`object`	object fields Nested object (not expanded)
`touch`	`object`	object fields Nested object (not expanded)
`stage`	`object`	object fields Nested object (not expanded)

meta

ResponseMeta | null

ResponseMeta fields

Field	Type	Description
`total`	`integer \| null`
`total_count`	`integer \| null`
`page`	`integer \| null`
`per_page`	`integer \| null`

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/public/chat/messages

Fetch webchat history (long-poll for new messages)

Return messages with ``id > since`` (whole thread when ``since`` omitted). Holds up to ``wait`` seconds (capped) until new messages arrive — the AI reply lands async, so the held request returns as soon as it's persisted.

Parameters

Name	In	Type	Description
`session_id`required	query	`string`
`since`	query	`string \| null`
`wait`	query	`integer`	default 0
`X-API-Key`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_dict_str__Any__

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`object`
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/public/chat/messages

Send a webchat message (anonymous visitor)

Parameters

Name	In	Type	Description
`X-API-Key`	header	`string \| null`

Request bodyrequired

application/jsonChatMessageBody

Field	Type	Description
`session_id`required	`string`
`body`required	`string`
`display_name`	`string \| null`
`email`	`string \| null`
`phone`	`string \| null`
`first_name`	`string \| null`
`last_name`	`string \| null`
`fbp`	`string \| null`
`fbc`	`string \| null`
`page_url`	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_dict_str__Any__

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`object`
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.