Skip to content

API overview

Base URL: https://api.cutweaver.io Self-hosted: whatever you bind the container to (default :8080).

All endpoints accept and return application/json. All requests are versioned via the URL path (/v1/...). The contract is additive — new fields may appear, existing fields never change meaning.

Endpoints

Method Path Auth Purpose
GET /health none liveness probe
GET /v1/info none service metadata + endpoint catalog
GET /v1/schema none request schema discovery
GET /v1/runtime none active host/port + CLI flags
POST /v1/solve optional the main endpoint — see POST /v1/solve
GET /v1/usage required current quota state for your key

Versioning policy

  • /v1/... will not break.
  • New fields added without bumping the version.
  • Breaking changes ship behind /v2/... with at least 6 months overlap.

Discovery

For tooling: hit GET /v1/schema to get a machine-readable list of supported fields, strategies, and limits. The JSON contract page is generated from the same source.