bots.listBots

GET

/v1/bots

const url = 'https://example.com/v1/bots?archived=true';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/v1/bots?archived=true' \
  --header 'Authorization: Bearer <token>'

Lists the Bots that the caller can use: their own Bots and the shared Bots. With bot, it lists the Bots that this Bot owns.

Authorizations

token
session

Parameters

Query Parameters

archived

string

Allowed values: true false

bot

string

>= 1 characters <= 128 characters

Responses

200

Success

application/json

Array<object>

object

required

string

>= 1 characters <= 128 characters

owner

required

Any of:

object

_tag

required

string

Allowed values: Member

userId

required

string

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
null

string

serviceTier

Any of:

string
null

string

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

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

400

BotInvalid | OrganizationRequired

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: BotInvalid

message

required

string

Example

{
  "_tag": "BotInvalid"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

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

application/json

Any of:

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

Example

{
  "_tag": "Forbidden"
}

404

BotNotFound

application/json

object

_tag

required

string

Allowed values: BotNotFound

bot

required

string

Example

{
  "_tag": "BotNotFound"
}

409

@nmnmcc/ability/Authorizer/Pending | BotConflict

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

Example

{
  "_tag": "Pending"
}

429

RateLimited

application/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

BotStorageUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: PolicyUnavailable

Example

{
  "_tag": "PolicyUnavailable"
}