🎨 SketchAPI Documentation
Table of Contents
- 📚 API Reference
- ⚡ Installation
- 🚀 Basic Usage
- 🔑 Getting an API Key
- 🧩 Components & UI
- 📚 What’s Next?
- 💡 Need Help?
📚 API Reference
- @sketchapi/sketchpad
- @sketchapi/doc
- @sketchapi/layer
- @sketchapi/fill
- @sketchapi/stroke
- SketchAPI Cloud
⚡ Installation
Install SketchAPI via yarn:
yarn add @sketchapi/sketchpad🚀 Basic Usage
Get started with just a few lines of code
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
})🔑 Getting an API Key
An API key is required to unlock premium features like removing ads and watermarks and enabling vector file sharing.
- Visit our Pricing page
- Choose the plan that suits your needs
- Sign up and complete the purchase
- Receive your API key via email
🧩 Components & UI
Core UI components include:
- 📤 Export pane - Save and share your work
- 🎯 Primary toolbar - Quick access to essential tools
- ⚙️ Settings pane - Customize your workspace
💾 Export Formats
Supported export options:
- 📸 Raster formats (JPEG, PNG) - Perfect for web sharing
- ⚡ Vector formats (PDF, SVG) - Ideal for scalable graphics
- 📁 Native SKETCHPAD format - Preserve all editing capabilities