Skip to main content
All CollectionsHosted Pages & Embedded Apps
Publishing, Sharing, Embedding, & Activating API Access for Your App
Publishing, Sharing, Embedding, & Activating API Access for Your App

Learn how to publish your model as an app, embed an app in a web page, and/or connect a simulation to an external system.

Updated over a week ago

How do I publish my model as an app?

After creating or editing your model, then customizing the appearance and behavior of your app, the next step is to Publish your app. Once your app is published, you will be able to share it, embed it, or power it remotely using our API.

To publish a model as an app, first select the model you wish to publish from the Pages section of Summit. From the Designer view, click the button labeled Publish. That's it!

How do I share an app?

You can generate a sharing link from the Hosted app tab under the Access section of your Page settings. Simply click the Copy button next to the URL field displayed under the heading Your app lives at... <URL>.

How to generate a link to share your Summit app.

Alternatively, when viewing the published version of the app, you can click the Share button in the top-right corner of the screen. After clicking this button, a window will appear with various sharing options under the Share tab:

  1. Choose to include the current values entered in the app's input fields as default values for visitors to your app by clicking the checkbox next to the text Include current values. Leave the box unchecked if you prefer the default values to be blank.

  2. You can rename the shared version of the app by typing in a new title for the app under the section Customize Title.

  3. You can also customize the app description that appears below the title by typing in a new description under the section labeled Customize description.

How to generate a sharing link for your app in Summit

Once you've made your selections, click the Copy button to copy the sharing link to your clipboard. You can then paste the link wherever you'd like to provide your audience with access to your app (according to the sharing permissions set when publishing the app).

πŸ”” Note: You can change the access settings to the app at any time by returning to the Hosted page section of your page settings choosing your desired access controls as before (see above; Your team only or Anyone with the link).

How do I embed my app in a webpage?

You can embed your app in a webpage using a simple iframe. To generate the HTML snippet, open the model you wish to embed, publish your app, then navigate to the Embed section of your Page settings, and make sure the toggle switch labeled Enable embedding is in the active position for your model. The Embed code that appears is the snippet of HTML you can copy and then paste into your website or application code in order to render your Summit app inline. It's that easy!

How to embed your Summit app in a webpage

This window also gives you the option to let visitors share the app by embedding it where they wish as well. To enable this feature, simply click the toggle labeled Allow anyone to embed this app and users will see Embed as a sharing option.

How to let anyone embed your Summit app in a webpage

πŸ”” Note: Model runs of hosted or embedded apps count as usage and will be tracked as credits used each billing period. For more information about Summit subscriptions and answers to common questions, see our Pricing page.

How do I adjust the size of the embedded app to fit my webpage?

If the default embed code does not match the size or scale requirements for your website, you can copy the snippet below (remember to add your iframe embed node where noted) and adjust the values (width, padding, position, et al.) to force an aspect ratio for the embedded display on the most common screen sizes and devices.

<style> #summit-app { width: 100%; position: relative; display: block; overflow: hidden; } #summit-app::before { content: ''; display: block; padding-bottom: 133.34%; } @media (orientation: landscape) { #summit-app::before { padding-bottom: 62.5%; } } #summit-app>iframe { position: absolute; top: 0; left: 0; right: 0; bottom: 0; width: 100%; height: 100%; overflow: scroll; } </style> <div id="summit-app"> <!-- Your Summit iframe embed code here --> </div>

If you run into any issues or would like some assistance, we're also happy to provide guidance on the values to use or update the code snippet for you so your app appears as expected. Just send us a message with a link to the destination webpage and details about your layout requirements for the app and we'll get right back to you! Contact us here.

How do I embed an app that I've visited on another webpage?

Similar to the method for sharing a published app (see above), apps that allow embedding (see above also) can be embedded wherever you'd like. Click the Share button in the top-right corner of the app you've visited. Select the Embed tab on the window that appears. You have the option to include the current values entered in the app's input fields as default values for visitors to the embedded app by clicking the checkbox next to the text Include current values. Leave the box unchecked if you prefer the default values to be blank. After making a selection, simply click Copy to copy the embed code and then paste into your website or application code to render the Summit app inline. Simple!

How to generate a embed code on a shared app

How do I use the API to run my app from anywhere?

The configuration to power your app from anywhere via API is just as simple as creating a public app in Summit. To get started, open the model you wish to connect to, set your model live, then navigate to the Endpoints screen under API from the left-side of the screen. The API endpoints available for your model are listed in the center of the screen and your API keys can be managed from the Manage API Keys button at the top of the screen. Additional information about API configuration, authentication, and running your model via API can be found in our technical reference guide here.

How to enable API access for your model

Did this answer your question?