ShaderWeaveDocs
On this page

Discovery

List generators and inspect param schemas.

GET /v1/generators

Public. Cached ~60s (Cache-Control: public, max-age=60).

Why it exists

  • Editors build control panels without hardcoding fields
  • Agents can call ShaderWeave without reading human docs
  • SDKs stay thin because the schema is the contract

Health

GET /v1/health

{
  "ok": true,
  "engineVersion": "0.2.0",
  "generators": 25
}

OpenAPI

URLPurpose
/v1/openapi.jsonMachine-readable OpenAPI 3.1
/v1/docsScalar interactive docs

The Markdown docs you’re reading are the human guide; OpenAPI is the wire contract.