Skip to content

Introduction

Welcome to the CanvasMesh documentation.

CanvasMesh is the frontend layer for files and AI agents. Upload any file, pick a renderer, and share a public URL — no sign-in needed for viewers.

Two ways to use CanvasMesh

Section titled “Two ways to use CanvasMesh”
Web Dashboard Upload files, manage canvases, and share links right in the browser. No install required.
CLI & SDK Programmatic access — create canvases from your terminal, code, or CI/CD.

Web Dashboard

Section titled “Web Dashboard”

The dashboard at canvasmesh.app is the quickest way to get started:

  1. Sign in with Google.
  2. Click New Canvas and drag in any file.
  3. CanvasMesh picks a built-in renderer automatically.
  4. Hit Share to get a public URL with optional expiration.

Workspaces, spaces, pinned canvases, and settings (API keys, visibility defaults) all live inside the dashboard.

Guides

Section titled “Guides”

Task-oriented walkthroughs of the main features.

Create and update canvases Upload files, refresh content, and switch renderers across CLI, SDK, and REST.
Sharing canvases Public share links with optional expiration and revocation.
Canvas versioning Every update creates a new version — retrieve or roll back any time.
Renderers How CanvasMesh picks a renderer and how to override it.
Direct uploads Upload large files directly to storage with presigned URLs.

API reference

Section titled “API reference”

Complete surface area of the CLI, SDK, and REST API.

CLI reference Every canvasmesh command, flag, and exit code.
JavaScript SDK CanvasClient class and all methods.
REST API Every endpoint at api.canvasmesh.app.
Renderer types All 9 built-in renderers and their default extensions.

Core concepts

Section titled “Core concepts”
  • Canvas — a file + a renderer + a shareable URL. The atomic unit of CanvasMesh.
  • Renderer — turns a file into an interactive view. 9 built-in renderers cover HTML, Markdown, code, images, and more.
  • Share link — a public URL that lets anyone view a canvas without an account. You control expiration and revocation.
  • Version — every content update creates a new version. Previous versions stay accessible.

Authentication

Section titled “Authentication”

All requests to the API use API keys. See Authentication for how to create and use them.

Community

Section titled “Community”