The Generated API
When you run dockrion run or build a Docker image with dockrion build, Dockrion generates a FastAPI application that serves your agent as an HTTP API. This section documents the API surface your callers interact with.
Endpoint Summary
Section titled “Endpoint Summary”| Method | Path | Auth | Purpose |
|---|---|---|---|
GET | / | No | Welcome page (HTML) |
GET | /health | No | Health check |
GET | /ready | No | Readiness probe |
GET | /metrics | No | Prometheus metrics |
GET | /schema | No | Agent I/O schema |
GET | /info | No | Agent metadata |
POST | /invoke | Yes | Invoke the agent |
POST | /invoke/stream | Yes | Invoke with SSE streaming |
POST | /runs | Yes | Create async run |
GET | /runs/{run_id} | Yes | Get run status |
GET | /runs/{run_id}/events | Yes | Subscribe to run events (SSE) |
DELETE | /runs/{run_id} | Yes | Cancel a run |
GET | /docs | No | Swagger UI |
GET | /redoc | No | ReDoc |
GET | /openapi.json | No | OpenAPI spec |
Public endpoints (/health, /ready, /schema, /info, /metrics) never require authentication, even when auth is enabled.
In This Section
Section titled “In This Section”| Page | What it covers |
|---|---|
| 4.1 Endpoints Reference | Per-endpoint details, curl examples, response models |
| 4.2 io_schema & Swagger | How Dockfile types become Swagger models |
| 4.3 Auth from Caller’s Perspective | How to pass API keys, JWTs, Swagger Authorize |
| 4.4 Streaming Consumption | Client-side SSE and async runs code (JS, Python, curl) |
Source:
packages/runtime/dockrion_runtime/app.py, endpoint modules inendpoints/
Previous: 3. CLI Reference | Next: 5. Guides & Recipes →