---
title: "Published Chat Connect"
method: POST
path: "/published-chat/connect"
tags: ["app"]
---

# Published Chat Connect

`POST /published-chat/connect`

## Request

- Base URL: `https://realtime-api.convai.com` (the document declares no server; this is the origin it was published from)
- URL: `https://realtime-api.convai.com/published-chat/connect`
- Auth: none declared

Start a single text-chat session from a one-time public launch grant.

## Response `200`

Successful Response

- ConnectResponse: Response model for /connect endpoint
  - `session_id` string, required: Unique session token
  - `request_trace_id` string, required: Server-side request trace ID for correlating client events, logs, telemetry, and session records for this /connect request
  - `character_session_id` string, required: Interaction session id
  - `room_url` string, required: URL of the room to connect to
  - `room_name` string, nullable: Room name (only for LiveKit transport)
  - `token` string, required: Authentication token for the room
  - `end_user_id` string, nullable: The end_user_id associated with this session when provided
  - `end_user_metadata` object, nullable: Metadata associated with the end user
  - `memory_status` string, nullable: What long-term memory will do for this session: 'disabled', 'active', or 'skipped_no_end_user' when the character has memory enabled but no end_user_id was supplied, so nothing will be remembered. Reported positively rather than left to be inferred from an absent end_user_id.
  - `room_session_id` string, uuid, nullable
  - `active_membership_id` string, uuid, nullable
  - `route_epoch` integer, nullable
  - `roster_epoch` integer, nullable
  - `partial_dispatch` boolean
  - `characters` ConnectCharacterResponse[], nullable
    - `membership_id` string, uuid, required
    - `character_id` string, uuid, required
    - `session_id` string, required
    - `character_session_id` string, required
    - `participant_identity` string, required
    - `is_initial` boolean, required
    - `provisioning_status` 'dispatch_queued' | 'dispatch_accepted' | 'dispatch_failed', required
    - `failure_code` string, nullable
    - `display_name` string, nullable: Character display name for roster UIs; None when unknown
    - `description` string, nullable: Character description; None when unknown
  - `capabilities` ActionProtocolCapabilities: Client-requested or server-selected realtime protocol capabilities. ``model_output_version`` remains absent for legacy clients so the serialized response shape is compatible with clients that use strict capability decoders.
    - `action_protocol_version` integer
    - `model_output_version` integer, nullable

## Changes

- **2026-09-22** `7c9b85cfea11`: 1 info
  - added the optional property `memory_status` to the response with the `200` status
- **2026-09-09** `00d82882f86f`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/convai/apis/convai-api/changes/published-chat/connect/post.md)

---

[API](https://skmtc.dev/convai/apis/convai-api.md) - [All operations](https://skmtc.dev/convai/apis/convai-api/llms.txt) - [OpenAPI document](https://skmtc.dev/convai/apis/convai-api/revisions/4361c107ef49?raw)