API PreviewComing Soon

The WidgetFlowAPI

Build widgets, manage canvases, and integrate with the spatial productivity platform. RESTful, documented, and developer-friendly.

Coming Soon

RESTful API Architecture

The WidgetFlow API will be built on REST principles with JSON responses. Authenticate with API keys, make requests, and build powerful integrations.

REST Endpoints

Standard HTTP methods. Predictable URLs. JSON everywhere.

Authentication

API keys with scoped permissions. OAuth 2.0 coming soon.

Webhooks

Real-time notifications for canvas events and user actions.

Coming Soon

Planned Endpoints

Everything you'll need to build powerful widgets. Full CRUD operations for widgets, canvases, events, and more.

Widgets API

Create, read, update, and delete widgets

POST/widgets
GET/widgets/:id
PUT/widgets/:id
DELETE/widgets/:id

Canvas API

Manage canvas state and objects

GET/canvas/:id
POST/canvas/:id/objects
PUT/canvas/:id/objects/:oid

Events API

Create and manage calendar events

GET/events
POST/events
GET/events/:id

Users API

Access user data and preferences

GET/users/me
GET/users/:id/canvases

Official SDKs

We're building official client libraries to help you get started faster. Type-safe, well-documented, and production-ready.

Coming Soon

JavaScript/TypeScript SDK

First-class TypeScript support. Works in Node.js and browsers.

$ npm install @widgetflow/sdk
Coming Soon

React Widget Kit

Build widget UIs with React components. Hot reloading included.

$ npm install @widgetflow/react

Future SDKs

Python SDKGo SDKRuby SDKRust SDK
Coming Soon

Authentication

Our planned authentication system will support multiple methods for different use cases.

API Keys

Coming Soon

Generate API keys from your developer dashboard. Include in request headers for authentication.

Authorization: Bearer wf_sk_live_...

Scoped Permissions

Coming Soon

Keys will be scoped to specific resources and actions. Fine-grained access control.

widgets:readwidgets:writecanvas:readevents:manage

OAuth 2.0

Coming Soon

For user-authorized access. Perfect for third-party integrations.

Planned

Rate Limits & Quotas

Generous limits planned for development and production. Upgrade as you scale.

Free

1,000
requests/hour
Popular

Pro

10,000
requests/hour

Enterprise

Unlimited
requests
Rate Limit Headers
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 987
X-RateLimit-Reset: 1704067200
When Limited (429)

If you exceed your rate limit, the API returns a 429 status code. Check the Retry-After header to know when to retry.

Coming Soon

Documentation Structure

We're building comprehensive guides and references. Everything you'll need to build production-ready widgets.

Documentation Preview
Getting Started
Quick Start Guide
Authentication
Rate Limits
Error Handling
Widget Development
Widget Lifecycle
Widget Types
Styling Widgets
Event Handling
API Reference
Widgets API
Canvas API
Events API
Users API
SDKs & Tools
JavaScript SDK
React Widget Kit
CLI Reference
Development Tools
Guides
Publishing to Widget Store
Monetization
Best Practices
Examples
Full documentation coming soon

Get API Access

Join our waitlist to be notified when the WidgetFlow API launches. Be among the first to build with our platform.

Request API Access
← Back to Developer Program
Be first to knowEarly accessShape the API