evCreate API 5.7 Help

evCreate API Overview

The evCreate API (application programming interface) is a connection point for external systems, software, services, custom scripts, and AI (artificial intelligence) bots and agents to call the Canvas Envision Creator's functionality programmatically.

The Canvas Envision Creator is a powerful and flexible web-based browser-agnostic editor of the Envision (evdoc) documents that supports interactive 3D CAD models, 3D animations, 2D drawings, image editing, video, multi-language text, and more for rich visualizations and animations. With this solution, you can easily create, review, and publish detailed step-by-step dynamic interactive work and training instructions for building, operating, and maintaining compound hardware, field equipment, assembly lines, complex machinery, and much more. These instructions empower frontline workers with the right information at the right time in the right format, driving continuous improvement and ensuring precision in every product.

Canvas Envision Creator

As the Canvas Envision Creator web app is written in TypeScript (TS), technically, the evCreate API is specifications of custom TS functions and data object types for other applications to log into the Canvas Envision Creator web app, access evdoc documents, and manage the document contents: create, update, and delete pages, layers, and 2D and 3D objects. To do so, the applications should call the API functions and process the return values. The functions accept arguments and return values of native TS and custom API data types. Multiple TS calls can be combined into scripts to perform complex document manipulations.

As TS is converted into JavaScript (JS) on compilation, you can implement the evCreate API in code and scripts written not only in TS but also in JS.

31 January 2025