Skip to content
OpenBot

bots.createGrant

POST
/v1/bots/{botId}/grants
curl --request POST \
  --url https://example.com/v1/bots/example/grants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "capability": { "action": "tools.call", "target": "example", "arguments": {} }, "effect": "allow", "scope": "once", "reason": "example" }'

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
capability
required
object
action
required
string
Allowed values: tools.call apps.call bots.create bots.delegate plans.run channels.send delegations.continue computers.acquire computers.create computers.delete computers.expose
target
required
string
<= 512 characters
arguments
object
effect
required
string
Allowed values: allow deny
scope
required
string
Allowed values: once chat lifetime
reason
string
<= 2000 characters

Responses

Section titled “Responses”

201

Section titled “201”

Success

Media typeapplication/json
object
id
required
string
>= 1 characters <= 128 characters
bot
required
string
>= 1 characters <= 128 characters
capability
required
object
action
required
string
Allowed values: tools.call apps.call bots.create bots.delegate plans.run channels.send delegations.continue computers.acquire computers.create computers.delete computers.expose
target
required
string
<= 512 characters
arguments
object
effect
required
string
Allowed values: allow deny
scope
required
string
Allowed values: once chat lifetime
chat
string
grantedBy
required
Any of:
object
_tag
required
string
Allowed values: Person
userId
required
string
reason
string
parent
string
>= 1 characters <= 128 characters
status
required
string
Allowed values: active used revoked
createdAt
required
number

Example 

{
  "capability": {
    "action": "tools.call"
  },
  "effect": "allow",
  "scope": "once",
  "grantedBy": {
    "_tag": "Person"
  },
  "status": "active"
}

400

Section titled “400”

BotInvalid | OrganizationRequired

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

Example 

{
  "_tag": "BotInvalid"
}

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”

BotNotFound

Media typeapplication/json
object
_tag
required
string
Allowed values: BotNotFound
bot
required
string

Example 

{
  "_tag": "BotNotFound"
}

409

Section titled “409”

@nmnmcc/ability/Authorizer/Pending | BotConflict

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: Pending
ticket
required
string
reason
string

Example 

{
  "_tag": "Pending"
}

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”

BotStorageUnavailable | AuthenticationUnavailable | RequestFailed

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

Example 

{
  "_tag": "PolicyUnavailable"
}