Download OpenAPI specification:Download
The Application Streaming API is mainly used to query which application streams are active for a given OVC instance or to initiate and manage a new application stream for developers desiring to embed OVC application streams into their own custom applications or environments.
It is not required to use any public apis to deploy and stream a custom kit-based application to an OVC instance and have it accessible via the Omniverse Cloud Launcher. For more information refer to the “Deploying Custom Kit Applications to Omniverse Cloud” guide.
All application streams for an OVC instance are initiated by the Application Streaming API and can be introspected via the same API, regardless of whether they are initiated via the Omniverse Cloud Launcher or some other custom application or environment.
The Omniverse Cloud Launcher uses those same APIs to display the available applications and their versions and to initiate a stream, as well as to show you all active streams for an OVC instance.
The primary reason to use the Application Streaming API is if you, as a developer, want to embed a streamed Omniverse Cloud application into your own application or environment. An example use case would be leveraging the graphics and computing power of an OVX node to stream a high-quality interactive render of a USD scene into your own application.
Return metadata information about application streaming sessions.
limit | integer (Limit) > 0 Default: 50 |
offset | integer (Offset) >= 0 Default: 0 |
sort-by | string (Sort By) Default: "created_time" Enum: "created_time" "username" Field by which to sort the items. |
order | string (Order) Default: "ASC" Enum: "ASC" "DESC" An enumeration. |
username | string (Username) |
from_time | string <date-time> (From Time) |
to_time | string <date-time> (To Time) |
{- "offset": 0,
- "limit": 50,
- "count": 2,
- "items": [
- {
- "session_id": "82a67a28-66e2-4f01-bdf8-2a20971f2457",
- "username": "jane@doe.com",
- "created_time": "2023-10-24T15:47:20Z",
- "updated_time": "2023-10-24T15:47:50Z"
}, - {
- "session_id": "3c8f3f66-377c-4b57-8b16-9e6fb53c8c0a",
- "username": "john@doe.com",
- "created_time": "2023-10-24T15:45:32Z",
- "updated_time": "2023-10-24T15:46:05Z"
}
]
}
Create a streaming session using the provided metadata information.
application required | string (application id) Application ID as registered with the application service |
application_version | string (Application version) Default: "default" Version of the application to spawn as available via the application service |
object (Application arguments) Default: {"usd_stage_uri":"","nucleus_connection_config":[]} Set of arguments to pass to an application on startup |
{- "application": "usd-composer",
- "application_version": "2023.2.1",
- "application_arguments": {
- "usd_stage_uri": "omniverse://store.cluster.az.omniverse.nvidia.com/project-a/stage.usd"
}
}
{- "session_id": "82a67a28-66e2-4f01-bdf8-2a20971f2457",
}
Terminate a streaming session based on its unique identifier.
session_id required | string (Session ID) Unique session ID |
{- "session_id": "82a67a28-66e2-4f01-bdf8-2a20971f2457"
}
{- "session_id": "82a67a28-66e2-4f01-bdf8-2a20971f2457",
- "satus": "deleted"
}
Return metadata information about a stream session using its unique session identifier.
session_id required | string (Session ID) Unique identifier of the session about which to return metadata information. |
{- "session_id": "82a67a28-66e2-4f01-bdf8-2a20971f2457",
- "username": "jane@doe.com",
- "created_time": "2023-10-24T15:47:20Z",
- "updated_time": "2023-10-24T15:47:50Z"
}