Skip to content

API Access Overview

Alexandar83 edited this page Jan 26, 2025 · 20 revisions

The Wall API provides tools for authentication, file management, and cost tracking. This page provides a concise reference to its endpoints and rate limits.

Base URL

  • Windows + Docker Desktop: http://localhost:8000/

  • Linux + Docker + Docker Compose: http://<WSL2 IP>:8000/

Endpoints

Endpoint URL Requires token authentication Rate limit scopes
Create User /api/v2/auth/users/ No Unauthenticated
Set Password /api/v2/auth/users/set_password/ Yes User management
Login (authenticate) /api/v2/auth/token/login/ No Authenticated +
Unauthenticated 🗒️
Logout (revoke token) /api/v2/auth/token/logout/ Yes User management
Delete User /api/v2/auth/users/me/{username}/ Yes User management +
Unauthenticated 🗒️
Upload File /api/v2/wallconfig-files/upload/ Yes File management
List Files /api/v2/wallconfig-files/list/ Yes Authenticated
Delete File /api/v2/wallconfig-files/delete/ Yes File management
Daily Profile Cost /api/v2/profiles/<int:profile_id>/overview/<int:day>/ Yes Authenticated
Daily Wall Cost /api/v2/profiles/overview/<int:day>/ Yes Authenticated
Total Wall Cost /api/v2/profiles/overview/ Yes Authenticated

Notes

🗒️ Unauthenticated and Authenticated rate limits are tracked separately, and the counters do not reset. Instead, they dynamically switch depending on the user's authentication state.

🗒️ Deleting a user requires authentication at the start of the request. However, once the user account is deleted, the session token is invalidated, and the user becomes unauthenticated. Any subsequent requests to this endpoint will fall under the "Unauthenticated" rate limit scope.

🗒️ For an exhaustive information about each endpoint and its parameters, please refer to the Detailed API Documentation


Rate Limit Scopes

Scope Limit
Unauthenticated (The user is not logged in) 5 / min
Authenticated (The user is logged in with a valid token) 100 / min
File management 5 / min
User management 10 / min

Detailed API Documentation

Endpoint URL
Swagger UI /api/v2/swagger-ui/
ReDoc /api/v2/redoc/
Schema /api/v2/schema/


Return to Top
Home Page


Clone this wiki locally