Skip to content

Commit da082c5

Browse files
update README with REST API reference
1 parent fe25fd9 commit da082c5

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,18 @@ cd ui && npm install && npm run dev # Terminal 2 → http://localhos
121121

122122
Upload traces and eval sets, select metrics, and view results with interactive span trees. Live-streamed traces appear in the "Local Dev" tab, grouped by session ID.
123123

124+
## REST API Reference
125+
126+
While the server is running, interactive API documentation is available at:
127+
128+
| Endpoint | Description |
129+
|----------|-------------|
130+
| [`/docs`](http://localhost:8001/docs) | Swagger UI with interactive request builder |
131+
| [`/redoc`](http://localhost:8001/redoc) | ReDoc reference documentation |
132+
| [`/openapi.json`](http://localhost:8001/openapi.json) | Raw OpenAPI 3.x schema (for code generation or CI) |
133+
134+
The OTLP receiver (port 4318) serves its own docs at `http://localhost:4318/docs`.
135+
124136
## MCP Server
125137

126138
Exposes evaluation tools to MCP clients. A `.mcp.json` at the project root lets Claude Code pick it up automatically.

0 commit comments

Comments
 (0)