Skip to content
OpenBot

computers.listComputers

GET
/v1/computers
curl --request GET \
  --url https://example.com/v1/computers \
  --header 'Authorization: Bearer <token>'

Lists the Computers that the caller can use: their own and the shared ones. With bot, it lists only the Computers that this Bot has the right to use.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
bot
string
>= 1 characters <= 128 characters

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
Array<object>
object
id
required
string
>= 1 characters <= 128 characters
name
required
string
owner
required
Any of:
object
_tag
required
string
Allowed values: Member
userId
required
string
source
required
Any of:
object
_tag
required
string
Allowed values: Provider
provider
required
string
>= 1 characters <= 128 characters
template
required
Any of:
string
state
required
string
Allowed values: starting running paused offline failed
features
required
object
pause
required
boolean
desktop
required
boolean
ports
required
boolean
pauseAfter
required
Any of:
integer
>= 60 <= 604800
createdBy
required
string
version
required
integer
<= 9007199254740991
createdAt
required
number
updatedAt
required
number
lastActiveAt
required
Any of:
number

Example 

[
  {
    "owner": {
      "_tag": "Member"
    },
    "source": {
      "_tag": "Provider"
    },
    "state": "starting"
  }
]

400

Section titled “400”

ComputerInvalid | OrganizationRequired

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

Example 

{
  "_tag": "ComputerInvalid"
}

401

Section titled “401”

AuthenticationRequired

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

Example 

{
  "_tag": "AuthenticationRequired"
}

403

Section titled “403”

PermissionDenied | MembershipRequired | ForbiddenOrigin

Media typeapplication/json
Any of:
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

Example 

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

404

Section titled “404”

ComputerNotFound | ComputerProviderNotFound | PairingInvalid

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

Example 

{
  "_tag": "ComputerNotFound"
}

409

Section titled “409”

ComputerConflict | ComputerUnsupported | ComputerNotReady

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: ComputerConflict
version
required
integer
<= 9007199254740991

Example 

{
  "_tag": "ComputerConflict"
}

429

Section titled “429”

RateLimited

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

Example 

{
  "_tag": "RateLimited"
}

502

Section titled “502”

ComputerProviderFailed

Media typeapplication/json
object
_tag
required
string
Allowed values: ComputerProviderFailed
message
required
string

Example 

{
  "_tag": "ComputerProviderFailed"
}

503

Section titled “503”

AuthorizationUnavailable | ComputersUnavailable | AuthenticationUnavailable

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

Example 

{
  "_tag": "AuthorizationUnavailable"
}