BoardAPI Documentation

Appearance

BoardAPICollaborative Whiteboard Platform

Build powerful collaborative whiteboards with real-time sync, custom objects, and webhooks

Get Started
API Reference
🎬

Frames & Presentation Mode

Structure boards into slides, rooms, and breakout areas. Lock modes for exams and presentations.

🎓

Student Zones

Unique feature! Assign personal areas to participants. Perfect for exams and individual work. Miro can't do this!

👁️

Presenter Modes

Follow Me (lead your audience) and Spectate (observe students). Real-time viewport synchronization.

🤖

AI Agents Platform

Autonomous agents react to board events. AI Tutor, Moderator, Timer presets - no code required.

🧩

Custom Components SDK

Build your own board objects with Shared State (CRDT-like). 17 SDK modules for developers.

🔌

API-First Platform

REST API + WebSocket + Webhooks. Embeddable, white-label ready, stateless users.

Quick Start ​

bash
# Create a new board
curl -X POST https://api.boardapi.io/api/v1/boards \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "My First Board",
    "expires_in_hours": 24
  }'
json
{
  "board_uuid": "abc-123-def",
  "access_links": {
    "host": "https://app.boardapi.io/board/abc-123?token=...",
    "guest": "https://app.boardapi.io/board/abc-123?token=..."
  }
}

Why BoardAPI? ​

Built for Developers ​

  • RESTful API - Simple, predictable endpoints
  • WebSocket Events - Real-time collaboration out of the box
  • TypeScript SDK - Full type safety and IntelliSense
  • Comprehensive Docs - Every endpoint, every parameter documented

Built for Scale ​

  • Multi-tenancy - Isolate organizations with API keys
  • Rate Limiting - Protect your infrastructure
  • Monitoring - Track performance and errors
  • CDN-Ready - Static assets optimized for edge caching

Built for Integration ​

  • Webhooks - React to board events in real-time
  • Custom Objects - Extend boards with your domain models
  • External Auth - Integrate with existing auth systems
  • Template Engine - Reuse board configurations
🎓 Educational Platforms

Create interactive lesson boards with vocabulary cards, quizzes, and collaborative exercises. Perfect for language schools and online education.

🎨 Design Collaboration

Build mood boards, design systems, and collaborative workspaces. Real-time cursor tracking and object manipulation.

📋 Project Management

Kanban boards, sprint planning, and team collaboration. Custom task cards with status tracking and webhooks.

🧪 Interactive Presentations

Create engaging presentations with interactive elements. Perfect for workshops, training sessions, and remote meetings.

Get Your API Key ​

  1. Visit Developer Dashboard
  2. Create a new organization
  3. Copy your API key
  4. Start building!

Support ​