API Reference

Start the server:

covecto serve --port 3000

All endpoints are under /v1/.

---

GET /v1/health

Health check.

Response 200

{
  "status": "ok",
  "version": "0.1.0"
}

---

GET /v1/metrics

Server metrics since startup.

Response 200

{
  "request_count": 42,
  "avg_processing_ms": 23.5
}

---

POST /v1/vectorize

Vectorize an image.

Request multipart/form-data

Field	Type	Required	Description
file	binary	✅	Image file (PNG, JPEG, WebP, BMP, GIF, TIFF)
engine	string	—	auto, spline, pixel-exact (default: auto)
format	string	—	svg, pdf, eps (default: svg)
preset	string	—	vtracer preset: bw, poster, photo
profile	string	—	Profile: icon, logo, photo, lineart
optimize	boolean	—	Run SVG optimization (default: true)
optimize_preset	string	—	default, safe, none
multipass	boolean	—	Multiple optimization passes
color_precision	int	—	Color quantization precision (1–32)
filter_speckle	int	—	Speckle noise threshold
corner_threshold	int	—	Corner detection (0–180)
splice_threshold	int	—	Path splice (0–100)
color_mode	string	—	color or binary
hierarchical	string	—	stacked or cutout
path_simplify	string	—	spline, polygon, none
layer_difference	int	—	Layer difference threshold
length_threshold	float	—	Minimum path length
max_iterations	int	—	Max quantization iterations
path_precision	int	—	Coordinate decimal places

Response 200 (format=svg)

{
  "svg": "<svg>...</svg>",
  "engine_used": "spline",
  "metadata": {
    "input_size": [128, 128],
    "svg_byte_size": 4520,
    "path_count": 24,
    "processing_time_ms": 12.3,
    "engine_used": "spline"
  }
}

Response 200 (format=pdf or eps)

Returns raw binary with Content-Type: application/pdf or application/postscript.

Error 400

{
  "error": "No file provided"
}

---

POST /v1/optimize

Optimize an existing SVG.

Request multipart/form-data

Field	Type	Required	Description
file	binary	✅	SVG file to optimize
preset	string	—	default, safe, none (default: default)
multipass	boolean	—	Multiple passes (default: false)
multipass_iterations	int	—	Pass count (default: 10)

Response 200

{
  "svg": "<svg>...</svg>",
  "original_size": 15240,
  "optimized_size": 8120,
  "reduction_pct": 46.7
}

---

OpenAPI Spec

The full OpenAPI 3.1 specification is available in the repository.