Skip to content

API Reference

Complete API documentation for YOLO-Toys.

Available Protocols

ProtocolUse CaseLatency
REST APISingle image inference, batch processingMedium
WebSocketReal-time video streamingLow

Quick Example

bash
# REST API
curl -X POST "http://localhost:8000/infer" \
  -F "file=@image.jpg" \
  -F "model=yolov8n.pt"
javascript
// WebSocket
const ws = new WebSocket('ws://localhost:8000/ws');
ws.send(blob); // Send JPEG frame

Released under the MIT License.