Creator API Reference

The Creator API allows you to build plugins for Lottie Creator.

Use this API to read and manipulate scenes, layers, shapes, keyframes, text, and assets, to persist data between sessions, and to drive your plugin UI.

Explore the Reference

Globals

The creator and console objects available in every plugin sandbox.

Nodes

Scene graph objects — scenes, layers, shapes, masks, and keyframes.

Types

Option objects, enums, and interfaces passed to and returned from API calls.

Values

Value objects such as colors, gradients, vectors, matrices, and path data.

UtilsAPI

Helpers for narrowing nodes, including isLayer() and isShape().

Building a Plugin

This reference covers the API surface. To get started with building and pulbishing plugins, follow these plugin guides.

Creator API