Overview

canopy 0.1.0

Sessions on the log, the install flow, and the console exchange.

Information

License:
OpenAPI version: 3.1.0

Integration API

What your backend and its executors call.

install

Your backend, before it has a key: propose an app document, poll for the tenant’s consent, read the document you are installed under, propose an update.

sessions

Your backend, with its install key: open sessions, mint the tokens your users and executors attach with, read or land records, end sessions.

executors

Your executors: claim a released call and mint the token an executor tails with.

Console API

What the tenant's console at app.canopyhq.dev calls. Listed for completeness; an integration does not call these.

console

The tenant’s console, not your backend: the human’s token exchanged from the issuer’s, consent, installs, and the sessions the tenant reads or ends.

resources

The tenant’s console: the inference options, connections, and secrets a tenant owns, which its installs select from.

system

Liveness.

Authentication

console_token

Canopy’s own console token, naming a user, a tenant, and a role.

Security scheme type: http

Bearer format: JWT

install_key

The install’s long-lived key, prefixed cnpy_, held by the vendor’s backend.

Security scheme type: http

issuer_token

The OIDC issuer’s token, taken at memberships and the console exchange.

Security scheme type: http

Bearer format: JWT

session_token

A short-lived token naming the one session it may attach to.

Security scheme type: http

Bearer format: JWT