Skip to main content
Version: Latest

Router OpenAPI Reference

This explorer is generated from the same Router route catalog that serves GET /openapi.json. The catalog also owns each operation's permission, sensitivity, and mutation audit action, so runtime discovery and this page do not maintain parallel policy tables. An Agent should query the running Router directly:

# Compact endpoint discovery
curl -sS http://localhost:8080/api/v1

# One operation, without loading the complete document
curl -sS 'http://localhost:8080/openapi.json?path=/api/v1/config&method=PATCH'

# Complete OpenAPI document
curl -sS http://localhost:8080/openapi.json

The Dashboard is only a human-facing proxy and is not required for Agent or Router operation.

This specification describes the Router management listener. Routed model traffic goes through Envoy and follows the separate inference API contract. Storage routes therefore appear only as /api/v1/storage/files and /api/v1/storage/vector-stores; the Router does not publish /v1/files or /v1/vector_stores aliases.

The generated contract declares the runtime-configurable Bearer scheme and the permission required by each operation. When management authentication is disabled, non-health operations also accept anonymous access; when it is set to bearer, send Authorization: Bearer <token>.

JSON request fields are generated from the Go request type decoded by each handler. Configuration values inside the yaml field are defined by the Configuration Schema, which is independently available from the Router at GET /api/v1/config/schema.

Configuration mutation requests are YAML-only and require the current ETag in If-Match. Use POST /api/v1/config/plan to obtain the ETag and candidate identity before PATCH or PUT.

OpenAPI3.0.0
API versionv1
Operations79
View generated JSON ↗
GET
/api/v1

Progressive API capability discovery

Operation ID ·get_api_v1

Authenticationruntime-configured bearer
Permissiondocs.read
Sensitivitypublic

Request

viewquery
string

Omit for a compact capability index or use operations to include endpoint metadata.

capabilityquery
string

Return one capability group.

audiencequery
string

Return operations intended for one caller type.

planequery
string

Return operations from one API plane.

visibilityquery
string

Return primary or advanced operations.

curl -sS -X GET \
  'http://localhost:8080/api/v1'

Responses

200Successful responseobject
400Bad requestobject