Open Orbit

Stored assets and page images

Understand the difference between a stored app asset, its public content address, and the image a page displays.

An app asset is a file you store for use in your app. Storing an image does not place the image on a page.

Storage and page content are separate

The Orbit REST API accepts file uploads as artifacts. An upload can include an app identifier to associate the file with that app.

A page must refer to the image before readers can see it. For the API upload method, a public artifact provides a content_url that you can use in your app.

The Upload app assets guide covers the request, response, and upload errors. This page explains the distinction between the stored file and its use on a page.

Public and private files

An artifact is private when you omit visibility from the upload request. Private artifacts have no public content address.

Use public only for a file that anyone can read. A public logo is suitable. A document with private client details is not.

Do not treat an app association as a privacy control. Choose the file's visibility for the people who may read the file.

One logo, two checks

Suppose your repair service needs a logo on its home page. This is an example.

The upload stores the logo file. The public upload response supplies the content address. You can then ask Orbit Agent to use that address in the home page header.

These are two separate results:

  • The upload response confirms that Orbit accepted the file.
  • The home page shows whether the app uses the correct image in the correct place.

If the upload succeeds but the header has no logo, check the page's image reference. A successful upload does not confirm the page change.

Use Upload app assets for the API upload steps. Use Edit a mockup to inspect the page that uses the image.