computerProviders.createComputerProvider

POST

/v1/computer-providers

curl --request POST \
  --url https://example.com/v1/computer-providers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "credentials": { "kind": "e2b", "apiKey": "example", "apiUrl": "example", "sandboxDomain": "example" }, "shared": true }'

Adds an account at a Computer provider. OpenBot checks the key with the provider first.

Authorizations

• token
• session

Request Body^required

Media typeapplication/json

object

name

required

string

>= 1 characters <= 120 characters

credentials

required

Any of:

object

object

kind

required

string

Allowed values: e2b

apiKey

required

string

>= 1 characters <= 4096 characters

apiUrl

string

>= 1 characters

sandboxDomain

string

>= 1 characters <= 253 characters

object

object

kind

required

string

Allowed values: daytona

apiKey

required

string

>= 1 characters <= 4096 characters

apiUrl

string

>= 1 characters

target

string

>= 1 characters <= 64 characters

shared

boolean

Responses

201

Success

Media typeapplication/json

object

id

required

string

>= 1 characters <= 128 characters

kind

required

string

Allowed values: e2b daytona

name

required

string

owner

required

Any of:

object

object

_tag

required

string

Allowed values: Member

userId

required

string

object

object

_tag

required

string

Allowed values: Organization

credentials

required

Any of:

object

object

kind

required

string

Allowed values: e2b

apiKey

required

object

set

required

boolean

hint

required

Any of:

string

string

null

null

apiUrl

required

Any of:

string

string

null

null

sandboxDomain

required

Any of:

string

string

null

null

object

object

kind

required

string

Allowed values: daytona

apiKey

required

object

set

required

boolean

hint

required

Any of:

string

string

null

null

apiUrl

required

Any of:

string

string

null

null

target

required

Any of:

string

string

null

null

version

required

integer

<= 9007199254740991

createdAt

required

number

updatedAt

required

number

Example

{
  "kind": "e2b",
  "owner": {
    "_tag": "Member"
  },
  "credentials": {
    "kind": "e2b"
  }
}

400

ComputerInvalid | OrganizationRequired

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ComputerInvalid

message

required

string

object

object

_tag

required

string

Allowed values: OrganizationRequired

Example

{
  "_tag": "ComputerInvalid"
}

401

AuthenticationRequired

Media typeapplication/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

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

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

object

object

_tag

required

string

Allowed values: MembershipRequired

object

object

_tag

required

string

Allowed values: ForbiddenOrigin

Example

{
  "_tag": "Forbidden"
}

404

ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ComputerNotFound

id

required

string

object

object

_tag

required

string

Allowed values: ComputerPathNotFound

path

required

string

object

object

_tag

required

string

Allowed values: ComputerSessionNotFound

id

required

string

>= 1 characters <= 128 characters

object

object

_tag

required

string

Allowed values: ComputerProviderNotFound

id

required

string

object

object

_tag

required

string

Allowed values: PairingInvalid

Example

{
  "_tag": "ComputerNotFound"
}

409

@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

object

object

_tag

required

string

Allowed values: ComputerProviderInUse

id

required

string

object

object

_tag

required

string

Allowed values: ComputerConflict

version

required

integer

<= 9007199254740991

executionId

string

>= 1 characters <= 128 characters

object

object

_tag

required

string

Allowed values: ComputerUnsupported

feature

required

string

Allowed values: pause desktop ports stream

object

object

_tag

required

string

Allowed values: ComputerNotReady

state

required

string

Allowed values: starting running paused offline failed

Example

{
  "_tag": "Pending"
}

429

RateLimited

Media typeapplication/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

502

ComputerProviderFailed | ComputerExecutionFailed

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ComputerProviderFailed

message

required

string

object

object

_tag

required

string

Allowed values: ComputerExecutionFailed

failure

required

object

errorId

required

string

>= 1 characters <= 128 characters

category

required

string

Allowed values: invalid forbidden not_found conflict unavailable external outcome_unknown interrupted

Example

{
  "_tag": "ComputerProviderFailed"
}

503

ComputersUnavailable | AuthenticationUnavailable | RequestFailed

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: PolicyUnavailable

object

object

_tag

required

string

Allowed values: ComputersUnavailable

object

object

_tag

required

string

Allowed values: AuthenticationUnavailable

object

object

_tag

required

string

Allowed values: RequestFailed

category

required

string

Allowed values: invalid forbidden not_found conflict unavailable external outcome_unknown interrupted

errorId

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "PolicyUnavailable"
}