fetch_ml/cmd/api-server/README.md

32 lines
602 B
Markdown

# API Server
WebSocket API server for the ML CLI tool...
## Usage
```bash
./bin/api-server --config configs/api/dev.yaml
```
## Endpoints
- `GET /health` - Health check
- `WS /ws` - WebSocket endpoint for CLI communication
## Binary Protocol
See [CLI README](../../cli/README.md#websocket-protocol) for protocol details.
## Configuration
Uses the same configuration file as the worker. Experiment base path is read from `base_path` configuration key.
## Example
```bash
# Start API server
./bin/api-server --listen :9100
# In another terminal, test with CLI
./cli/zig-out/bin/ml status
```