On this page
Introduction
ShaderWeave is an API-first generative graphics engine. Describe a design in JSON and get production-ready pixels back.
ShaderWeave is an API of deterministic design generators. You describe a design as a recipe (generator slug + params + seed + engine version) and get a production-ready image, animation, or code snippet back. Same input, same pixels.
This documentation covers the public REST API, core concepts, and how to integrate ShaderWeave into apps, CI, and agent toolchains.
What you can build
- Backgrounds & textures for products, marketing sites, and design tools
- Deterministic assets in CI (golden PNG hashes)
- Agent-callable design APIs with machine-readable discovery
- Interactive editors with live preview (this dashboard)
Core ideas
| Idea | Meaning |
|---|---|
| Generator | A named renderer (shader-gradient, marble-vein, …) with a Zod param schema |
| Recipe | Canonical JSON: generator + params + seed + engine version |
| Seed | Integer that drives PRNG / domain offsets; 0 derives from params hash |
| Determinism | Same recipe, size, format, engine and renderer versions → deterministic still output |
Surfaces
| Surface | URL |
|---|---|
| Tools UI | /tools |
| Editor | /g/<slug> |
| This docs site | /docs |
| OpenAPI (Scalar) | /v1/docs |
| OpenAPI JSON | /v1/openapi.json |
Next steps
- Quickstart: first PNG in under a minute
- Authentication: API keys
- Generate:
POST /v1/generate/:slug - Generators: registry and params