CreativeEngine APIs

The APIs of the CreativeEngine allow you to programmatically manipulate scenes inside the editor to automate workflows and customize the user experience.

Accessing the CreativeEngine APIs#

You can access the CreativeEngine APIs via the engine object and interact with the scene seen on screen.

The examples in the API Guides will use the headless CreativeEngine:

import 'https://cdn.img.ly/packages/imgly/cesdk-engine/1.38.0/index.js';

const config = {
  baseURL: 'https://cdn.img.ly/packages/imgly/cesdk-engine/1.38.0/assets'
};

CreativeEngine.init(config).then((engine) => {
  // Work with the engine...
  engine.scene.create();
});

API Guides#

Scene
Load, create, and save scenes or control the zoom.

Block
Manipulate blocks, the elements a scene is made of, in various ways.

Editor
Control settings or history and observe state changes in your engine instance.

Asset
Manage assets by creating and reading from AssetSources.

Event
Subscribe to block creation, update and destruction events.

Variable
Manage the values of pre-defined variables, allowing for quick customization of things like headlines.