API Reference Documentation#

Overview

The Application and Profile APIs are designed to manage and introspect the applications and profiles. They encompass three main areas:

Applications

Manages the applications that are available in a deployment.

Application Versions

Manages the versions of an application that are available in an Omniverse Cloud instance. Application versions are in the format of major.minor.patch[-pre-release][+build-metadata].

• The first part before the hyphen (-) indicates the major.minor.patch version.
• The part between the hyphen (-) and plus (+) sign (if present) is the pre-release version.
• The part after the plus (+) sign (if present) is the build metadata.

Application version examples:

• 1.0.0
• 2.1.3-alpha.1
• 3.2.4-beta+001
• 4.3.5-rc.1+build.123
• 5.4.6+build.metadata

Application Profiles

Predefined runtime environments for a given application allowing to fine tune an instance of an application. It allows pre-configuring a set of resources, additional configuration etc.

Use Cases

Introspection

The primary use case for these APIs is to provide a detailed view of the applications, their versions and runtime profiles available in a deployment.

Developer Integration

For developers aiming to integrate Omniverse Cloud Application Streams into custom web environments, these APIs provide the necessary endpoints to check application availability and initiate streams based on specific applications, heir versions and profiles

Summary

Leveraging the Application and Profile APIs ensures a seamless application management and streaming experience for developers integrating streaming capabilities into custom solutions.