Skip to content

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.

MethodPathAuthPurpose
GET/NoWelcome page (HTML)
GET/healthNoHealth check
GET/readyNoReadiness probe
GET/metricsNoPrometheus metrics
GET/schemaNoAgent I/O schema
GET/infoNoAgent metadata
POST/invokeYesInvoke the agent
POST/invoke/streamYesInvoke with SSE streaming
POST/runsYesCreate async run
GET/runs/{run_id}YesGet run status
GET/runs/{run_id}/eventsYesSubscribe to run events (SSE)
DELETE/runs/{run_id}YesCancel a run
GET/docsNoSwagger UI
GET/redocNoReDoc
GET/openapi.jsonNoOpenAPI spec

Public endpoints (/health, /ready, /schema, /info, /metrics) never require authentication, even when auth is enabled.

PageWhat it covers
4.1 Endpoints ReferencePer-endpoint details, curl examples, response models
4.2 io_schema & SwaggerHow Dockfile types become Swagger models
4.3 Auth from Caller’s PerspectiveHow to pass API keys, JWTs, Swagger Authorize
4.4 Streaming ConsumptionClient-side SSE and async runs code (JS, Python, curl)

Source: packages/runtime/dockrion_runtime/app.py, endpoint modules in endpoints/


Previous: 3. CLI Reference | Next: 5. Guides & Recipes →