Skip to content

API Reference

Every name exported from the top-level veloce package, grouped by what it is for. Each page is generated from the source docstrings.

  • Application - The application object and its configuration.
  • Routers, Blueprints & Views - The route-group primitives a project is structured with.
  • Parameters & Converters - The declarations that bind a handler's arguments to parts of the request, and the path converters behind them.
  • Requests - The request object and the parsed containers it exposes.
  • Responses - The base response and every response class shipped with the framework.
  • Dependency Injection - The markers that declare what a handler needs and how it is authorised.
  • Middleware - The middleware base classes and every middleware shipped with the framework.
  • Security - Authentication schemes, token handling, password hashing, and the signing primitives underneath them.
  • Sessions - The session mapping and the server-side stores that back it.
  • Helpers & Context - The request-scoped proxies, response shortcuts, and control-flow helpers.
  • Templating & Static Files - Jinja2 integration and the static-file mount.
  • WebSockets & Server-Sent Events - The WebSocket connection object and the server-sent-event response types.
  • Background Work, Caching & Rate Limiting - Work that runs after the response, the cache interface, rate-limit strategies, and runtime instrumentation.
  • Exceptions & Status Codes - The exception hierarchy, the built-in handlers, and the status-code constants.
  • OpenAPI & Encoding - Schema generation and the JSON encoding layer.
  • Testing - The in-memory test clients.
  • MCP (AI Tools) - The Model Context Protocol server, registries, and transports. Most applications drive MCP through app.mount_mcp(...), @app.mcp_tool, and @app.mcp_prompt; these names are for callers that assemble or serve the registry themselves.