bots.updateBot

PATCH

/v1/bots/{botId}

curl --request PATCH \
  --url https://example.com/v1/bots/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expected": 1, "name": "example", "role": "example", "instructions": "example", "model": { "_tag": "Config.Selection", "provider": "example", "model": "example", "reasoningEffort": "example", "serviceTier": "example" }, "planApproval": { "approver": "chain", "timeoutMs": 1, "onTimeout": "run" }, "archived": true }'

Authorizations

• token
• session

Parameters

Path Parameters

botId

required

string

>= 1 characters <= 128 characters

Request Body^required

Media typeapplication/json

object

expected

required

integer

<= 9007199254740991

name

string

role

string

<= 500 characters

instructions

string

<= 20000 characters

model

Any of:

object

object

_tag

required

string

Allowed values: Config.Selection

provider

required

string

model

required

string

reasoningEffort

Any of:

string

string

null

null

serviceTier

Any of:

string

string

null

null

null

null

planApproval

Any of:

object

object

approver

required

string

Allowed values: chain person

timeoutMs

required

integer

>= 1000 <= 604800000

onTimeout

required

string

Allowed values: run stay

null

null

archived

boolean

Responses

200

Success

Media typeapplication/json

object

id

required

string

>= 1 characters <= 128 characters

kind

required

string

Allowed values: persistent session

owner

required

Any of:

object

object

_tag

required

string

Allowed values: Member

userId

required

string

object

object

_tag

required

string

Allowed values: Organization

object

object

_tag

required

string

Allowed values: Session

userId

required

string

session

required

string

bot

required

string

>= 1 characters <= 128 characters

object

object

_tag

required

string

Allowed values: Bot

bot

required

string

>= 1 characters <= 128 characters

userId

required

Any of:

string

string

null

null

name

required

string

role

required

string

instructions

required

string

model

object

_tag

required

string

Allowed values: Config.Selection

provider

required

string

model

required

string

reasoningEffort

Any of:

string

string

null

null

serviceTier

Any of:

string

string

null

null

planApproval

object

approver

required

string

Allowed values: chain person

timeoutMs

required

integer

>= 1000 <= 604800000

onTimeout

required

string

Allowed values: run stay

source

object

organizationId

required

string

bot

required

string

>= 1 characters <= 128 characters

archived

required

boolean

revision

required

integer

<= 9007199254740991

createdAt

required

number

updatedAt

required

number

Example

{
  "kind": "persistent",
  "owner": {
    "_tag": "Member"
  },
  "model": {
    "_tag": "Config.Selection"
  },
  "planApproval": {
    "approver": "chain",
    "onTimeout": "run"
  }
}

400

BotInvalid | OrganizationRequired

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: BotInvalid

message

required

string

object

object

_tag

required

string

Allowed values: OrganizationRequired

Example

{
  "_tag": "BotInvalid"
}

401

AuthenticationRequired

Media typeapplication/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

PermissionDenied | MembershipRequired | ForbiddenOrigin

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: PermissionDenied

permission

required

string

Allowed values: responses.run sessions.read sessions.write requests.resolve bots.read bots.write bots.delegate bots.share triggers.read triggers.write channels.read channels.write channels.use channel_identities.read channel_identities.write connections.read connections.write apps.use apps.publish computers.read computers.write computers.use computer_providers.read computer_providers.write computer_providers.use models.use tokens.read tokens.write organization.read organization.write roles.write model_providers.read model_providers.write sso.read sso.write platform.read platform.write members.read members.write audit_logs.read usage.read budgets.read budgets.write

resource

required

string

object

object

_tag

required

string

Allowed values: MembershipRequired

object

object

_tag

required

string

Allowed values: ForbiddenOrigin

Example

{
  "_tag": "PermissionDenied",
  "permission": "responses.run"
}

404

BotNotFound

Media typeapplication/json

object

_tag

required

string

Allowed values: BotNotFound

bot

required

string

Example

{
  "_tag": "BotNotFound"
}

409

BotConflict

Media typeapplication/json

object

_tag

required

string

Allowed values: BotConflict

message

required

string

Example

{
  "_tag": "BotConflict"
}

429

RateLimited

Media typeapplication/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

AuthorizationUnavailable | BotStorageUnavailable | AuthenticationUnavailable

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: AuthorizationUnavailable

object

object

_tag

required

string

Allowed values: BotStorageUnavailable

object

object

_tag

required

string

Allowed values: AuthenticationUnavailable

Example

{
  "_tag": "AuthorizationUnavailable"
}