api-access

← All modules

4 endpoints.

GET /api/v1/settings/api-access

Get Api Access

200 — Successful Response

{
  "properties": {
    "api_key": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Api Key"
    },
    "has_secret": {
      "type": "boolean",
      "title": "Has Secret"
    },
    "api_scopes": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Api Scopes"
    },
    "mcp_url": {
      "type": "string",
      "title": "Mcp Url"
    }
  },
  "type": "object",
  "required": [
    "api_key",
    "has_secret",
    "api_scopes",
    "mcp_url"
  ],
  "title": "ApiAccessOut"
}

---

DELETE /api/v1/settings/api-access

Revoke Api Access

200 — Successful Response

{}

---

POST /api/v1/settings/api-access/generate

Generate Api Access

Rotate: issue a fresh key+secret pair, invalidating any previous one.

200 — Successful Response

{
  "properties": {
    "api_key": {
      "type": "string",
      "title": "Api Key"
    },
    "api_secret": {
      "type": "string",
      "title": "Api Secret"
    }
  },
  "type": "object",
  "required": [
    "api_key",
    "api_secret"
  ],
  "title": "ApiAccessGenerated"
}

---

PATCH /api/v1/settings/api-access/scopes

Set Api Scopes

Cap which AI Agent MCP tools this API key may call (Phase 5). Empty list or None = the full read surface the owner's role permits.

Request body

{
  "properties": {
    "api_scopes": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Api Scopes"
    }
  },
  "type": "object",
  "required": [
    "api_scopes"
  ],
  "title": "ApiScopesIn"
}

200 — Successful Response

{}

422 — Validation Error

{
  "properties": {
    "detail": {
      "items": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}