Skip to content
OpenBot

live.createLiveChat

POST
/v1/bots/{botId}/live
curl --request POST \
  --url https://example.com/v1/bots/example/live \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "model": { "_tag": "Config.Selection", "provider": "example", "model": "example", "reasoningEffort": "example", "serviceTier": "example" } }'

Makes a new live Chat of yours with this Bot. Then open its Live WebSocket. You need bots.delegate on the Bot and models.use on the Live model.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
botId
required
string
>= 1 characters <= 128 characters

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
model
object
_tag
required
string
Allowed values: Config.Selection
provider
required
string
model
required
string
reasoningEffort
Any of:
string
serviceTier
Any of:
string

Responses

Section titled “Responses”

201

Section titled “201”

Success

Media typeapplication/json
object
chat
required
object
id
required
string
revision
required
integer
<= 9007199254740991
kind
required
string
Allowed values: direct channel task review live
bot
required
string
>= 1 characters <= 128 characters
parent
required
Any of:
object
chat
required
string
delegation
required
string
>= 1 characters <= 128 characters
title
string
settings
required
object
mode
required
string
Allowed values: build plan
model
object
_tag
required
string
Allowed values: Config.Selection
provider
required
string
model
required
string
reasoningEffort
Any of:
string
serviceTier
Any of:
string
planApproval
object
approver
required
string
Allowed values: chain person
timeoutMs
required
integer
>= 1000 <= 604800000
onTimeout
required
string
Allowed values: run stay
createdAt
required
number
status
required
string
Allowed values: Idle Running Completed Failed Interrupted
turn
required
Any of:
object
id
required
string
chat
required
string
settings
required
object
mode
required
string
Allowed values: build plan
model
object
_tag
required
string
Allowed values: Config.Selection
provider
required
string
model
required
string
reasoningEffort
Any of:
string
serviceTier
Any of:
string
action
object
name
required
string
>= 1 characters
arguments
required
object
source
object
author
string
>= 1 characters
activeAction
object
item
required
string
action
required
object
name
required
string
>= 1 characters
arguments
required
object
source
object
status
required
Any of:
object
_tag
required
string
Allowed values: Running
steps
required
integer
<= 9007199254740991
usage
Array<object>
object
inputTokens
required
object
uncached
Any of:
integer
>= -9007199254740991 <= 9007199254740991
total
Any of:
integer
>= -9007199254740991 <= 9007199254740991
cacheRead
Any of:
integer
>= -9007199254740991 <= 9007199254740991
cacheWrite
Any of:
integer
>= -9007199254740991 <= 9007199254740991
outputTokens
required
object
total
Any of:
integer
>= -9007199254740991 <= 9007199254740991
text
Any of:
integer
>= -9007199254740991 <= 9007199254740991
reasoning
Any of:
integer
>= -9007199254740991 <= 9007199254740991
input
required
Array<string>
items
required
Array<string>
startedAt
required
number
completedAt
number
response
required
Any of:
object
usage
object
inputTokens
required
object
total
integer
>= -9007199254740991 <= 9007199254740991
uncached
integer
>= -9007199254740991 <= 9007199254740991
cacheRead
integer
>= -9007199254740991 <= 9007199254740991
cacheWrite
integer
>= -9007199254740991 <= 9007199254740991
outputTokens
required
object
total
integer
>= -9007199254740991 <= 9007199254740991
text
integer
>= -9007199254740991 <= 9007199254740991
reasoning
integer
>= -9007199254740991 <= 9007199254740991
id
required
string
object
required
string
Allowed values: response
created_at
required
integer
<= 9007199254740991
chat
required
string
background
required
boolean
status
required
string
Allowed values: in_progress completed incomplete failed cancelled
output
required
Array<object>
object
id
required
string
type
required
string
Allowed values: message
role
required
string
Allowed values: assistant
status
required
string
Allowed values: in_progress completed incomplete
content
required
Array<object>
object
type
required
string
Allowed values: output_text
text
required
string
annotations
required
array
error
required
Any of:
object
code
required
string
Allowed values: model_error internal_error
message
required
string
incomplete_details
required
Any of:
object
reason
required
string
Allowed values: max_output_tokens content_filter other
executionId
required
Any of:
string
>= 1 characters <= 128 characters
inbox
required
integer
<= 9007199254740991
open
required
object
delegations
required
integer
<= 9007199254740991
requests
required
integer
<= 9007199254740991
reminders
required
integer
<= 9007199254740991

Example 

{
  "chat": {
    "kind": "direct",
    "settings": {
      "mode": "build",
      "model": {
        "_tag": "Config.Selection"
      }
    },
    "planApproval": {
      "approver": "chain",
      "onTimeout": "run"
    }
  },
  "status": "Idle",
  "turn": {
    "settings": {
      "mode": "build",
      "model": {
        "_tag": "Config.Selection"
      }
    },
    "status": {
      "_tag": "Running"
    }
  },
  "response": {
    "object": "response",
    "background": true,
    "status": "in_progress",
    "output": [
      {
        "type": "message",
        "role": "assistant",
        "status": "in_progress",
        "content": [
          {
            "type": "output_text"
          }
        ]
      }
    ],
    "error": {
      "code": "model_error"
    },
    "incomplete_details": {
      "reason": "max_output_tokens"
    }
  }
}

400

Section titled “400”

ChatModelInvalid | BotInvalid | 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 | BotNotFound

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

Example 

{
  "_tag": "ChatNotFound"
}

409

Section titled “409”

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

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 | BotStorageUnavailable | AuthenticationUnavailable | RequestFailed

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

Example 

{
  "_tag": "ChatStorageUnavailable"
}