Getting Started with SketchAPI
Get up and running with SketchAPI in minutes.
Installation
pnpm add @sketchapi/sketchpad Quick Setup
import { Sketchpad } from '@sketchapi/sketchpad'
const sketchpad = new Sketchpad(config)
document.body.appendChild(sketchpad)
await sketchpad.load({
onprogress: (e) => console.log(e.loaded / e.total),
onload: () => console.log('loaded'),
onerror: (e) => console.error(e),
signal: controller.signal
}) API Key Setup
An API key unlocks premium features including watermark removal, vector export, and file sharing.
- Visit the Pricing page and choose a plan
- Complete the purchase to receive your key via email
- Pass the key in your Sketchpad config to activate
What’s Included
- 18 Brushes — Calligraphy, Spirograph, Mirror, Crayon, and more
- 14 Shapes — Customizable with fills, outlines, and transforms
- 800+ Fonts — Google Fonts with text-on-path support
- 5,000+ Clipart — Open-source vectors for commercial use
- Colors — Solid, gradient, and pattern fills
- Layers — Reorderable, toggleable layer management
- Export — PDF, PNG, JPEG, SVG, and native SKETCHPAD
Browse the full Tools Reference for details on every brush, shape, and utility.
Explore the Docs
Build
- Configuration — Theme, export, and workspace settings
- Components — Toolbar, export pane, and settings panel
- Examples — Working apps and code samples
Reference
- App Config — Full Sketchpad instance configuration schema
- Document Format — Document structure and layer specification
Need Help?
- Join the Discord community
- Report issues on GitHub
- Email us at [email protected]
Ready to build?