"Save Flattened As..." python API

[dongzhue]

Hey, I’m using Isaac Sim 5.0.

In the GUI there’s a “File → Save Flattened As” option that saves the current stage as a single USD file.
I want to do the exact same thing from a Python script, but I can’t find the API for it.

Does anyone know:

• What’s the Python function that the GUI uses for “Save As Flattened”?
• Is it just UsdUtils.FlattenLayerStack(stage) or something Omniverse-specific?
• Bonus: is there also a way to directly export that flattened stage as USDZ?

Basically I just want the same result as clicking that menu, but in code.
Thanks!

[vick-yu]

Based on the documentation for the omni.kit.window.file module, you can use the save_as() function to achieve the same result as the "Save Flattened As" option in the GUI.

The save_as() function takes a flatten parameter, which is a boolean. By setting flatten=True, you can save the current stage as a single, flattened USD file.

Here's the function signature:
omni.kit.window.file.save_as(flatten, on_save_done: Callable[[bool, str], None] | None = None)
For a simple script, you would likely use it like this:

import omni.kit.window.file

# This will bring up a file picker dialog to choose where to save
omni.kit.window.file.save_as(flatten=True)

For more information, you can refer to the official Omniverse Kit documentation.

[dongzhue]

Thank you very much for your reply. I’m curious whether there is an API that supports specifying the save path when saving a stage as flattened, as I need to process the dataset in batches.