Embed API

The Embed API is a JavaScript based API for creating embedded content elements within a host web page or application. It has a native JavaScript version as well as versions that work in React and Angular.

Accessing the Embed API package

There are 2 techniques for accessing the API library file:

Direct Reference

Add a script tag to the host page referencing the JavaScript file (with your specifics changed out):

<script src=”http://mysite.com/no-shell/pyramid-embed-js.min.js”></script>


Inside your development project install the API using the following syntax for NPM:


npm i @pyramid-embed/embed-js


npm i @pyramid-embed/embed-angular


npm i @pyramid-embed/embed-react

Embed API Structure

The main technique for programming the with the Embed APIs is to instantiate and use the Pyramid Embed client object. The key objects in the Embed API, including the client, are described here.

API Examples

Click here to see an example of embedding using JavaScript on GitHub.