Consent requires the tenant's owner and checks every selected reference belongs to that tenant before creating the grant and key. Session start checks the live catalogs.

POST

/consent/{request}

curl --request POST \
  --url https://api.canopyhq.dev/consent/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "extra_tools": [ { "connection": "example", "tool": "example" } ], "inference": "example", "policies": [ { "allow": true, "items": [ { "arg": "example", "effect": "allow", "op": "is", "operand": { "value": "example" } } ], "posture": "permissive", "project": [ "example" ], "tool": "example" } ] }'

Authorizations

• console_token

Parameters

Path Parameters

request

required

One proposal. Minted per POST, so two proposals of one document are two requests, each with its own secret and its own key.

string

The request being consented to.

Request Body^required

Media typeapplication/json

What the tenant lands at consent. Inference must be selected; an empty policy list allows every tool and an empty extra-tools list adds nothing. The policies name tools as the model sees them and compile in policy, against the surface the resolved connections give, which is not this type’s to know.

object

extra_tools

Array<object>

A tool the tenant brings that the vendor did not state: a pre-registered remote, such as an MCP server the tenant already links to.

object

connection

required

string

tool

required

The name by which an MCP server identifies and invokes a tool.

string

inference

required

string

policies

Array<object>

The tenant’s rules for one tool, named by the name the model sees.

object

allow

The tool enable. Off, nothing else here matters.

boolean

items

Array<object>

One condition: <allow|deny> if <arg> <op> <operand>.

object

arg

required

string

effect

required

string

Allowed values: allow deny

op

required

string

Allowed values: is is_not in not_in lt gt

operand

required

One of:

object

object

value

required

object

object

arg_ref

required

string

posture

What a tool’s allow items do: nothing under Permissive, where only deny items bind; bind under Restrictive, where a conditioned arg must satisfy one of them.

string

Allowed values: permissive restrictive

project

Args projected for evidence alone, conditioned or not.

Array<string>

tool

required

string

Responses

200

The install the consent created, or the existing install an update kept with its key.

Media typeapplication/json

object

install

required

Opaque; never the key, never anything the vendor chose.

string

Example^generated

{
  "install": "example"
}

400

Parse errors identify the field and reason when available. The tenant config may not fit the vendor’s, or may name an inference option, connection, or tool the tenant does not own.

401

No console token, or one that did not verify.

403

Only an owner of the tenant may consent for it.

404

No such request, or it lapsed.

409

The request was granted already.