Skip to content
OpenBot

live.connectLive

GET
/v1/chats/{chatId}/live
curl --request GET \
  --url 'https://example.com/v1/chats/example/live?turnDetection=server' \
  --header 'Authorization: Bearer <token>'

Opens the Live WebSocket of a live Chat. Each thing the person says starts a Turn, and the Bot answers with sound and text. Turns use the shared execution engine. Sound stays on the open connection. A browser must connect from the public origin.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
chatId
required
string
>= 1 characters

Query Parameters

Section titled “Query Parameters”
voice
string
>= 1 characters
inputFormat
string
/^(?:pcm16|g711_ulaw|g711_alaw|opus)@[+-]?(?:\d+(?:\.\d+)?|\.\d+)(?:[Ee][+-]?\d+)?$/
outputFormat
string
/^(?:pcm16|g711_ulaw|g711_alaw|opus)@[+-]?(?:\d+(?:\.\d+)?|\.\d+)(?:[Ee][+-]?\d+)?$/
turnDetection
string
Allowed values: server client
organization
string
>= 1 characters

Responses

Section titled “Responses”

204

Section titled “204”

400

Section titled “400”

ChatModelInvalid | OrganizationRequired

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: ChatModelInvalid
reason
required
string
Allowed values: provider-not-found model-not-found unsupported-option missing
message
required
string

Example 

{
  "_tag": "ChatModelInvalid",
  "reason": "provider-not-found"
}

401

Section titled “401”

AuthenticationRequired

Media typeapplication/json
object
_tag
required
string
Allowed values: AuthenticationRequired

Example 

{
  "_tag": "AuthenticationRequired"
}

403

Section titled “403”

@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: Forbidden
action
required
string
kind
required
string
field
string
reason
string

Example 

{
  "_tag": "Forbidden"
}

404

Section titled “404”

ChatNotFound

Media typeapplication/json
object
_tag
required
string
Allowed values: ChatNotFound
chat
required
string

Example 

{
  "_tag": "ChatNotFound"
}

409

Section titled “409”

ChatConflict | LiveUnavailable | @nmnmcc/ability/Authorizer/Pending

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: ChatConflict
message
required
string

Example 

{
  "_tag": "ChatConflict"
}

429

Section titled “429”

RateLimited

Media typeapplication/json
object
_tag
required
string
Allowed values: RateLimited
retryAfterSeconds
required
integer
>= -9007199254740991 <= 9007199254740991

Example 

{
  "_tag": "RateLimited"
}

503

Section titled “503”

ChatStorageUnavailable | ChatExecutionUnavailable | AuthenticationUnavailable | RequestFailed

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: ChatStorageUnavailable

Example 

{
  "_tag": "ChatStorageUnavailable"
}