Apikeys

3 actions. Each is callable by the agent as a tool, over HTTP via /api/invoke, and (usually) from a UI page.

`apikeys.list`

GET

List API keys (personal access tokens) in the current workspace. Returns metadata only — the secret token is never retrievable after creation.

AI tool: apikeys_list
API: GET /api/invoke/apikeys.list

Input

No parameters.

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {}
}

`apikeys.create`

POST · mutating

Mint a new API key for programmatic / MCP access. The plaintext token is returned ONCE — copy it immediately. The key authenticates as you, scoped to the active workspace, so a connected AI gets the same capabilities you have in the app.

AI tool: apikeys_create
API: POST /api/invoke/apikeys.create

Input

Field	Type	Required	Description
`name`	string	yes	Label for the key, e.g. "Claude Desktop"
`scope`	"full" \| "read"	—	'full' (default) = your role; 'read' = non-mutating tools only
`expiresInDays`	integer	—	Optional expiry in days; omit for a key that never expires

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "description": "Label for the key, e.g. \"Claude Desktop\""
    },
    "scope": {
      "description": "'full' (default) = your role; 'read' = non-mutating tools only",
      "type": "string",
      "enum": [
        "full",
        "read"
      ]
    },
    "expiresInDays": {
      "description": "Optional expiry in days; omit for a key that never expires",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "name"
  ]
}

`apikeys.revoke`

POST · mutating

Revoke an API key by id. Takes effect immediately — any future call presenting that key is rejected.

AI tool: apikeys_revoke
API: POST /api/invoke/apikeys.revoke

Input

Field	Type	Required	Description
`id`	string	yes

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "id"
  ]
}