API docs by Redocly

Application Public APIs (2.0.0)

Download OpenAPI specification:Download

Overview

The Application Public APIs are designed to manage and introspect the applications available within an Omniverse Cloud instance. They encompass three main areas:

Applications

Manages the applications that are available in an Omniverse Cloud instance.

Application Releases

Handles the management of releases for specific applications. A "Release" is a shorthand to a specific version. It is easyier for users to select a release, such as "Production", "Development" or "QA" and provide methods to update the version a release points to. This reduces the need for users of the platform to know what versions are 'valid'

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

Use Cases

Introspection

The primary use case for these APIs is to provide a detailed view of the applications, their releases, and versions available in an Omniverse Cloud instance.

Omniverse Cloud Launcher Integration

The Omniverse Cloud Launcher, predominantly used by end-users for launching streaming applications, is a primary consumer of these APIs. It queries the Application API to display available applications and their versions, facilitating easy stream initiation for end-users.

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 and their versions.

Summary

Leveraging the Application Public APIs ensures a seamless application management and streaming experience, both for end-users interacting with the Omniverse Cloud Launcher and developers integrating streaming capabilities into custom solutions.

Application APIs

Return all registered applications

Return all registered applications

Authorizations:
HTTPBearer
query Parameters
limit
integer (Limit) > 0
Default: 50
offset
integer (Offset) >= 0
Default: 0
sort-by
string (Sort By)
Default: "created_time"
Enum: "created_time" "updated_time" "app_id"

Field by which to sort the items.

order
string (Order)
Default: "ASC"
Enum: "ASC" "DESC"

An enumeration.

tags
Array of strings (tags)
Default: ""

Tags to filter by

Responses

Response samples

Content type
application/json
{
  • "offset": 0,
  • "limit": 50,
  • "count": 2,
  • "items": [
    ]
}

Return information about a specific application

Return metadata information about an application using its unique application identifier.

Authorizations:
HTTPBearer
path Parameters
app_id
required
string (Application ID)

Unique identifier of the application.

Responses

Response samples

Content type
application/json
{
  • "app_id": "usd-composer",
  • "application_name": "Omniverse USD Composer",
  • "application description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
  • "tags": [
    ]
}

Application Release APIs

Return all releases for a given application

Return all releases for a given application

Authorizations:
HTTPBearer
path Parameters
app_id
required
string (Application ID)

Unique identifier of the application.

query Parameters
limit
integer (Limit) > 0
Default: 50
offset
integer (Offset) >= 0
Default: 0
sort-by
string (Sort By)
Default: "created_time"
Value: "created_time"

Field by which to sort the items.

order
string (Order)
Default: "ASC"
Enum: "ASC" "DESC"

An enumeration.

Responses

Response samples

Content type
application/json
{
  • "offset": 0,
  • "limit": 50,
  • "count": 2,
  • "items": [
    ]
}

Return information about a specific application release

Return information about a specific application release

Authorizations:
HTTPBearer
path Parameters
app_id
required
string (Application ID)

Unique identifier of the application.

release
required
string (Release ID)

Unique identifier of the release about which to return metadata information.

Responses

Response samples

Content type
application/json
{
  • "release_id": "production",
  • "description": "Pointer to a production ready version",
  • "linked_version": {
    }
}

Application Version APIs

Return all versions for a given application

Return all versions for a given application

Authorizations:
HTTPBearer
path Parameters
app_id
required
string (Application ID)

Unique identifier of the application.

query Parameters
limit
integer (Limit) > 0
Default: 50
offset
integer (Offset) >= 0
Default: 0
sort-by
string (Sort By)
Default: "version"
Value: "version"

Field by which to sort the items.

order
string (Order)
Default: "ASC"
Enum: "ASC" "DESC"

An enumeration.

Responses

Response samples

Content type
application/json
{
  • "offset": 0,
  • "limit": 50,
  • "count": 2,
  • "items": [
    ]
}

Return information about a specific application version

Return information about a specific application version

Authorizations:
HTTPBearer
path Parameters
app_id
required
string (Application ID) ^[a-zA-Z0-9\-]+$

Unique identifier of the application.

version
required
string (Version ID) ^\d+\.\d+\.\d+(-[0-9A-Za-z-]+(\.[0-9A-Za-z-]+...

Unique identifier of the version about which to return metadata information.

Responses

Response samples

Content type
application/json
{
  • "version": "1.2.3-alpha.1+build.42"
}