Endpoints

1. Root Endpoint

• URL: /

• Method: GET

• Description: Health check endpoint to verify that the API is running.

• Authentication: None

• Response:

  • Status Code: 200 OK

  • Body:

    {
      "message": "API Key Management and PDF Processing System is up and running."
    }

---

2. User Management

2.1. Create User

• URL: /create-user

• Method: POST

• Description: Creates a new user in the system. Admin only.

• Authentication: HTTP Basic (Admin credentials)

• Request Body:

  • Content-Type: application/json

  • Schema: CreateUserRequest

  {
    "username": "string (3-50 characters, alphanumeric)",
    "password": "string (min 8 characters, at least one digit and one uppercase letter)"
  }

• Responses:

  • 201 Created

    {
      "message": "User created successfully."
    }

  • 400 Bad Request

    • Reason: Username already exists or validation error.

    {
      "detail": "Username already exists."
    }

  • 401 Unauthorized

    {
      "detail": "Unauthorized"
    }

2.2. Remove User

• URL: /remove-user

• Method: POST

• Description: Removes an existing user and their associated API key. Admin only.

• Authentication: HTTP Basic (Admin credentials)

• Request Body:

  • Content-Type: application/json

  • Schema: RemoveUserRequest

    {
      "username": "string"
    }

• Responses:

  • 200 OK

    {
      "message": "User 'username' and their API key have been removed."
    }

  • 404 Not Found

    • Reason: User does not exist.

    {
      "detail": "User not found."
    }

  • 401 Unauthorized

    {
      "detail": "Unauthorized"
    }

---