Create a new empty tldraw document with one default page. Replaces any currently loaded document.

Load a .tldr file from disk. Replaces any currently loaded document.

Save the current document to a .tldr file on disk.

Get an overview of the current document: pages, shape counts per page, total bindings, and assets.

Add a new page to the document.

List all pages in the document with their IDs, names, and shape counts.

Rename a page.

Delete a page and all its shapes. Cannot delete the last remaining page.

Move a page before or after another page in the page list.

Create a geometric shape. 20 subtypes available: rectangle, ellipse, triangle, diamond, pentagon, hexagon, octagon, star, rhombus, rhombus-2, oval, trapezoid, arrow-right, arrow-left, arrow-up, arrow-down, x-box, check-box, cloud, heart. Supports text labels inside the shape.

Create a text shape on the canvas.

Create an arrow shape. Supports straight, curved (bend), and auto-binding to shapes. Set startBinding/endBinding to connect the arrow to shapes.

Create a freehand drawing shape from an array of points. Points are encoded into tldraw's internal format automatically.

Create a line shape with multiple control points. Supports straight line segments or cubic spline interpolation.

Create a sticky note shape. Notes have a fixed square size and colored background.

Create a frame shape. Frames act as containers — other shapes can be reparented into them using tldraw_reparent_shapes.

Create an image shape. Requires an asset ID (create one first with tldraw_create_asset).

Create a video shape. Requires an asset ID (create one first with tldraw_create_asset).

Create an embed shape for external content (YouTube, Figma, CodeSandbox, Google Maps, etc.).

Create a highlighter stroke shape from an array of points. Similar to draw but with translucent highlight appearance.

Create a bookmark shape that displays a URL preview card.

Move shapes by delta (relative) or to absolute position. Provide deltaX/deltaY for relative moves, or toX/toY for absolute positioning.

Set width and/or height of shapes.

Set rotation of shapes in radians.

Delete shapes and cascade-delete their bindings and children.

Duplicate shapes with an optional offset.

Change visual style properties of shapes (color, fill, dash, size, font).

Low-level: directly set any properties on a shape's props object. Use with caution.

Set opacity of shapes (0 = transparent, 1 = fully opaque).

Lock or unlock shapes. Locked shapes cannot be selected or moved in the UI.

Change z-order of shapes: move to front, to back, one step forward, or one step backward.

Move shapes into or out of frames/groups. Set newParentId to a frame/group ID to nest, or to a page ID to un-nest.

Group multiple shapes together into a group shape. Minimum 2 shapes required.

Dissolve a group, promoting its children back to the parent level.

List shapes on a page. Optionally filter by shape type and/or color.

Get full details of a shape including all its properties.

Get all bindings (arrow connections) that involve a specific shape.

Bind an arrow's start or end terminal to a target shape. This creates a visual connection that follows the shape when moved.

Remove the binding from an arrow's start or end terminal.

List all bindings (arrow connections) in the document, optionally filtered by page.

Create an asset record (image, video, or bookmark). Use the returned asset ID with shape creation tools like tldraw_create_image or tldraw_create_video.

List all assets in the current document.

Set the camera (viewport) position and zoom level for a page.