COconvai
app

Published Chat Connect

Changed on

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

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

Response

Successful Response

session_idstring required

Unique session token

request_trace_idstring required

Server-side request trace ID for correlating client events, logs, telemetry, and session records for this /connect request

character_session_idstring required

Interaction session id

room_urlstring required

URL of the room to connect to

room_namestring nullable

Room name (only for LiveKit transport)

tokenstring required

Authentication token for the room

end_user_idstring nullable

The end_user_id associated with this session when provided

end_user_metadataobject nullable

Metadata associated with the end user

memory_statusstring 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_idstring uuid nullable
active_membership_idstring uuid nullable
route_epochinteger nullable
roster_epochinteger nullable
partial_dispatchboolean

Changes