Skip to content

AutoGPT is the vision of accessible AI for everyone, to use and to build on. Our mission is to provide the tools, so that you can focus on what matters.

refactor(backend): move the API-key routes into their own feature module (#14456)

Reinier van der Leerf464da0c8914
diff --git a/autogpt_platform/backend/backend/api/features/api_keys/__init__.py b/autogpt_platform/backend/backend/api/features/api_keys/__init__.py
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/autogpt_platform/backend/backend/api/features/api_keys/model.py b/autogpt_platform/backend/backend/api/features/api_keys/model.py
new file mode 100644
index 0000000000..2520b98df1
--- /dev/null
+++ b/autogpt_platform/backend/backend/api/features/api_keys/model.py
@@ -0,0 +1,20 @@
+from typing import Optional
+
+import pydantic
+
+from backend.data.auth.api_key import APIKeyInfo, APIKeyPermission
+
+
+class CreateAPIKeyRequest(pydantic.BaseModel):
+ name: str
+ permissions: list[APIKeyPermission]
+ description: Optional[str] = None
+
+
+class CreateAPIKeyResponse(pydantic.BaseModel):
+ api_key: APIKeyInfo
+ plain_text_key: str
+
+
+class UpdatePermissionsRequest(pydantic.BaseModel):
+ permissions: list[APIKeyPermission]
diff --git a/autogpt_platform/backend/backend/api/features/api_keys/routes.py b/autogpt_platform/backend/backend/api/features/api_keys/routes.py
new file mode 100644
index 0000000000..758673264e
--- /dev/null
+++ b/autogpt_platform/backend/backend/api/features/api_keys/routes.py
@@ -0,0 +1,96 @@
+from typing import Annotated
+
+from autogpt_libs.auth import get_request_context, get_user_id, requires_user
+from autogpt_libs.auth.models import RequestContext
+from fastapi import APIRouter, HTTPException, Security
+
+from backend.api.features.api_keys.model import (
+ CreateAPIKeyRequest,
+ CreateAPIKeyResponse,
+ UpdatePermissionsRequest,
+)
+from backend.data.auth import api_key as api_key_db
+from backend.data.tenancy import get_user_team_ids
+
+router = APIRouter(dependencies=[Security(requires_user)])
+
+
[email protected]("", summary="Create new API key")
+async def create_api_key(
+ request: CreateAPIKeyRequest,
+ user_id: Annotated[str, Security(get_user_id)],
+ ctx: Annotated[RequestContext, Security(get_request_context)],
+) -> CreateAPIKeyResponse:
+ """Create a new API key"""
+ api_key_info, plain_text_key = await api_key_db.create_api_key(
+ name=request.name,
+ user_id=user_id,
+ permissions=request.permissions,
+ description=request.description,
+ organization_id=ctx.org_id,
+ )
+ return CreateAPIKeyResponse(api_key=api_key_info, plain_text_key=plain_text_key)
+
+
[email protected]("", summary="List user API keys")
+async def get_api_keys(
+ user_id: Annotated[str, Security(get_user_id)],
+ ctx: Annotated[RequestContext, Security(get_request_context)],
+) -> list[api_key_db.APIKeyInfo]:
+ """List all API keys for the user"""
+ team_ids = await get_user_team_ids(user_id, ctx.org_id) if ctx.org_id else []
+ return await api_key_db.list_user_api_keys(
+ user_id, organization_id=ctx.org_id or None, team_ids=team_ids
+ )
+
+
[email protected]("/{key_id}", summary="Get specific API key")
+async def get_api_key(
+ key_id: str,
+ user_id: Annotated[str, Security(get_user_id)],
+ ctx: Annotated[RequestContext, Security(get_request_context)],
+) -> api_key_db.APIKeyInfo:
+ """Get a specific API key"""
+ api_key = await api_key_db.get_api_key_by_id(
+ key_id, user_id, organization_id=ctx.org_id or None
+ )
+ if not api_key:
+ raise HTTPException(status_code=404, detail="API key not found")
+ return api_key
+
+
[email protected]("/{key_id}", summary="Revoke API key")
+async def delete_api_key(
+ key_id: str,
+ user_id: Annotated[str, Security(get_user_id)],
+ ctx: Annotated[RequestContext, Security(get_request_context)],
+) -> api_key_db.APIKeyInfo:
+ """Revoke an API key"""
+ return await api_key_db.revoke_api_key(
+ key_id, user_id, organization_id=ctx.org_id or None
+ )
+
+
[email protected]("/{key_id}/suspend", summary="Suspend API key")
+async def suspend_key(
+ key_id: str,
+ user_id: Annotated[str, Security(get_user_id)],
+ ctx: Annotated[RequestContext, Security(get_request_context)],
+) -> api_key_db.APIKeyInfo:
+ """Suspend an API key"""
+ return await api_key_db.suspend_api_key(
+ key_id, user_id, organization_id=ctx.org_id or None
+ )
+
+
[email protected]("/{key_id}/permissions", summary="Update key permissions")
+async def update_permissions(
+ key_id: str,
+ request: UpdatePermissionsRequest,
+ user_id: Annotated[str, Security(get_user_id)],
+ ctx: Annotated[RequestContext, Security(get_request_context)],
+) -> api_key_db.APIKeyInfo:
+ """Update API key permissions"""
+ return await api_key_db.update_api_key_permissions(
+ key_id, user_id, request.permissions, organization_id=ctx.org_id or None
+ )
diff --git a/autogpt_platform/backend/backend/api/features/api_keys/routes_test.py b/autogpt_platform/backend/backend/api/features/api_keys/routes_test.py
new file mode 100644
index 0000000000..d24d2de847
--- /dev/null
+++ b/autogpt_platform/backend/backend/api/features/api_keys/routes_test.py
@@ -0,0 +1,49 @@
+"""Pins the published API-key surface: paths, operation IDs and tags are contract.
+
+Operation IDs are built from each route's summary and first tag, so renaming
+either silently renames the generated frontend client's method.
+"""
+
+import pytest
+from fastapi.routing import APIRoute
+
+from backend.api.rest_api import app
+
+EXPECTED_OPERATIONS = {
+ ("get", "/api/api-keys"): "getV1List user api keys",
+ ("post", "/api/api-keys"): "postV1Create new api key",
+ ("delete", "/api/api-keys/{key_id}"): "deleteV1Revoke api key",
+ ("get", "/api/api-keys/{key_id}"): "getV1Get specific api key",
+ ("put", "/api/api-keys/{key_id}/permissions"): "putV1Update key permissions",
+ ("post", "/api/api-keys/{key_id}/suspend"): "postV1Suspend api key",
+}
+
+
+ "method,path,operation_id",
+ [(m, p, oid) for (m, p), oid in EXPECTED_OPERATIONS.items()],
+)
+def test_api_key_operation_is_published(method: str, path: str, operation_id: str):
+ operation = app.openapi()["paths"][path][method]
+ assert operation["operationId"] == operation_id
+ assert operation["tags"] == ["v1", "api-keys"]
+
+
+def test_api_key_surface_has_no_other_operations():
+ published = {
+ (method, path)
+ for path, operations in app.openapi()["paths"].items()
+ if path.startswith("/api/api-keys")
+ for method in operations
+ }
+ assert published == set(EXPECTED_OPERATIONS)
+
+
[email protected]("path", sorted({p for _, p in EXPECTED_OPERATIONS}))
+def test_api_key_path_is_served_by_this_module(path: str):
+ handlers = {
+ route.endpoint.__module__
+ for route in app.routes
+ if isinstance(route, APIRoute) and route.path == path
+ }
+ assert handlers == {"backend.api.features.api_keys.routes"}
diff --git a/autogpt_platform/backend/backend/api/features/orgs/regression_test.py b/autogpt_platform/backend/backend/api/features/orgs/regression_test.py
index d899f93f44..74bdcb5980 100644
--- a/autogpt_platform/backend/backend/api/features/orgs/regression_test.py
+++ b/autogpt_platform/backend/backend/api/features/orgs/regression_test.py
@@ -3047,9 +3047,9 @@ class TestPR18Cutover:
# After cutover, the route should ALWAYS set org (not conditionally)
import inspect
- from backend.api.features import v1 as api_v1
+ from backend.api.features.api_keys import routes as api_key_routes
- route_src = inspect.getsource(api_v1.create_api_key)
+ route_src = inspect.getsource(api_key_routes.create_api_key)
assert (
"if ctx.org_id" not in route_src
), "Route should always set organizationId, not conditionally"
diff --git a/autogpt_platform/backend/backend/api/features/v1.py b/autogpt_platform/backend/backend/api/features/v1.py
index 300fa2ea33..3ae1120acc 100644
--- a/autogpt_platform/backend/backend/api/features/v1.py
+++ b/autogpt_platform/backend/backend/api/features/v1.py
@@ -47,14 +47,11 @@ from backend.api.features.experts import experts_db
from backend.api.features.store.exceptions import VirusDetectedError, VirusScanError
from backend.api.features.workspace.routes import create_file_download_response
from backend.api.model import (
- CreateAPIKeyRequest,
- CreateAPIKeyResponse,
CreateGraph,
GraphExecutionSource,
RequestTopUp,
SetGraphActiveVersion,
TimezoneResponse,
- UpdatePermissionsRequest,
UpdateTimezoneRequest,
UploadFileResponse,
)
@@ -74,7 +71,6 @@ from backend.copilot.tools.skills import (
)
from backend.data import execution as execution_db
from backend.data import graph as graph_db
-from backend.data.auth import api_key as api_key_db
from backend.data.block import BlockInput, CompletedBlockOutput
from backend.data.credit import (
AutoTopUpConfig,
@@ -2930,119 +2926,3 @@ async def delete_copilot_skill(
except SkillNotFoundError as exc:
raise HTTPException(status_code=HTTP_404_NOT_FOUND, detail=str(exc))
return {"name": slug}
-
-
-########################################################
-##################### API KEY ##############################
-########################################################
-
-
-@v1_router.post(
- "/api-keys",
- summary="Create new API key",
- tags=["api-keys"],
- dependencies=[Security(requires_user)],
-)
-async def create_api_key(
- request: CreateAPIKeyRequest,
- user_id: Annotated[str, Security(get_user_id)],
- ctx: Annotated[RequestContext, Security(get_request_context)],
-) -> CreateAPIKeyResponse:
- """Create a new API key"""
- api_key_info, plain_text_key = await api_key_db.create_api_key(
- name=request.name,
- user_id=user_id,
- permissions=request.permissions,
- description=request.description,
- organization_id=ctx.org_id,
- )
- return CreateAPIKeyResponse(api_key=api_key_info, plain_text_key=plain_text_key)
-
-
-@v1_router.get(
- "/api-keys",
- summary="List user API keys",
- tags=["api-keys"],
- dependencies=[Security(requires_user)],
-)
-async def get_api_keys(
- user_id: Annotated[str, Security(get_user_id)],
- ctx: Annotated[RequestContext, Security(get_request_context)],
-) -> list[api_key_db.APIKeyInfo]:
- """List all API keys for the user"""
- team_ids = await get_user_team_ids(user_id, ctx.org_id) if ctx.org_id else []
- return await api_key_db.list_user_api_keys(
- user_id, organization_id=ctx.org_id or None, team_ids=team_ids
- )
-
-
-@v1_router.get(
- "/api-keys/{key_id}",
- summary="Get specific API key",
- tags=["api-keys"],
- dependencies=[Security(requires_user)],
-)
-async def get_api_key(
- key_id: str,
- user_id: Annotated[str, Security(get_user_id)],
- ctx: Annotated[RequestContext, Security(get_request_context)],
-) -> api_key_db.APIKeyInfo:
- """Get a specific API key"""
- api_key = await api_key_db.get_api_key_by_id(
- key_id, user_id, organization_id=ctx.org_id or None
- )
- if not api_key:
- raise HTTPException(status_code=404, detail="API key not found")
- return api_key
-
-
-@v1_router.delete(
- "/api-keys/{key_id}",
- summary="Revoke API key",
- tags=["api-keys"],
- dependencies=[Security(requires_user)],
-)
-async def delete_api_key(
- key_id: str,
- user_id: Annotated[str, Security(get_user_id)],
- ctx: Annotated[RequestContext, Security(get_request_context)],
-) -> api_key_db.APIKeyInfo:
- """Revoke an API key"""
- return await api_key_db.revoke_api_key(
- key_id, user_id, organization_id=ctx.org_id or None
- )
-
-
-@v1_router.post(
- "/api-keys/{key_id}/suspend",
- summary="Suspend API key",
- tags=["api-keys"],
- dependencies=[Security(requires_user)],
-)
-async def suspend_key(
- key_id: str,
- user_id: Annotated[str, Security(get_user_id)],
- ctx: Annotated[RequestContext, Security(get_request_context)],
-) -> api_key_db.APIKeyInfo:
- """Suspend an API key"""
- return await api_key_db.suspend_api_key(
- key_id, user_id, organization_id=ctx.org_id or None
- )
-
-
-@v1_router.put(
- "/api-keys/{key_id}/permissions",
- summary="Update key permissions",
- tags=["api-keys"],
- dependencies=[Security(requires_user)],
-)
-async def update_permissions(
- key_id: str,
- request: UpdatePermissionsRequest,
- user_id: Annotated[str, Security(get_user_id)],
- ctx: Annotated[RequestContext, Security(get_request_context)],
-) -> api_key_db.APIKeyInfo:
- """Update API key permissions"""
- return await api_key_db.update_api_key_permissions(
- key_id, user_id, request.permissions, organization_id=ctx.org_id or None
- )
diff --git a/autogpt_platform/backend/backend/api/model.py b/autogpt_platform/backend/backend/api/model.py
index 5a357a4e39..ad247fb2e3 100644
--- a/autogpt_platform/backend/backend/api/model.py
+++ b/autogpt_platform/backend/backend/api/model.py
@@ -3,7 +3,6 @@ from typing import Any, Literal, Optional
import pydantic
-from backend.data.auth.api_key import APIKeyInfo, APIKeyPermission
from backend.data.graph import Graph
from backend.data.onboarding_steps import OnboardingStep
from backend.util.timezone_name import TimeZoneName
@@ -45,25 +44,10 @@ class CreateGraph(pydantic.BaseModel):
source: GraphCreationSource | None = None
-class CreateAPIKeyRequest(pydantic.BaseModel):
- name: str
- permissions: list[APIKeyPermission]
- description: Optional[str] = None
-
-
-class CreateAPIKeyResponse(pydantic.BaseModel):
- api_key: APIKeyInfo
- plain_text_key: str
-
-
class SetGraphActiveVersion(pydantic.BaseModel):
active_graph_version: int
-class UpdatePermissionsRequest(pydantic.BaseModel):
- permissions: list[APIKeyPermission]
-
-
class RequestTopUp(pydantic.BaseModel):
credit_amount: int
diff --git a/autogpt_platform/backend/backend/api/rest_api.py b/autogpt_platform/backend/backend/api/rest_api.py
index 8b6ae95340..59b159e78a 100644
--- a/autogpt_platform/backend/backend/api/rest_api.py
+++ b/autogpt_platform/backend/backend/api/rest_api.py
@@ -28,6 +28,7 @@ import backend.api.features.admin.platform_cost_routes
import backend.api.features.admin.rate_limit_admin_routes
import backend.api.features.admin.store_admin_routes
import backend.api.features.admin.test_data_routes
+import backend.api.features.api_keys.routes as api_keys_routes
import backend.api.features.auth_email.routes as auth_email_routes
import backend.api.features.briefings.routes
import backend.api.features.builder
@@ -381,6 +382,11 @@ app.add_exception_handler(Exception, handle_internal_http_error(500))
app.include_router(backend.api.features.v1.v1_router, tags=["v1"], prefix="/api")
app.include_router(subscription_trial_routes.router, prefix="/api")
+app.include_router(
+ api_keys_routes.router,
+ tags=["v1", "api-keys"],
+ prefix="/api/api-keys",
+)
app.include_router(
auth_email_routes.auth_email_router,
prefix="/api/auth/email",