Skip to content

protocol

Parse ChatKit requests and encode responses at a transport boundary.

parse_request

parse_request(body: str | bytes | bytearray) -> ChatKitReq

Decode JSON into a validated ChatKit request.

Source code in chatkit/protocol.py
12
13
14
15
16
17
def parse_request(body: str | bytes | bytearray) -> ChatKitReq:
    """Decode JSON into a validated ChatKit request."""
    try:
        return _request_adapter.validate_json(body)
    except ValidationError as error:
        raise InvalidRequestError(error) from error

encode_message

encode_message(message: BaseModel) -> bytes

Encode a response model in ChatKit's JSON wire format.

Source code in chatkit/protocol.py
20
21
22
23
24
25
26
def encode_message(message: BaseModel) -> bytes:
    """Encode a response model in ChatKit's JSON wire format."""
    return message.model_dump_json(
        by_alias=True,
        exclude_none=True,
        context={"exclude_metadata": True, "browser_wire": True},
    ).encode("utf-8")

encode_sse

encode_sse(event: ThreadStreamEvent) -> bytes

Encode one ChatKit event as a Server-Sent Event frame.

Source code in chatkit/protocol.py
29
30
31
def encode_sse(event: ThreadStreamEvent) -> bytes:
    """Encode one ChatKit event as a Server-Sent Event frame."""
    return b"data: " + encode_message(event) + b"\n\n"