USD Search API 1.0.0 beta#

This is a public release of the USD Search API on API catalog.

USD Search API allows both text-based and image-based search through embedding matching, allowing users to query their scene or databases for relevant OpenUSD assets.

Key Features#

  • Query the OpenUSD asset database via the API catalog

  • Integrate the API through an endpoint within a sample application for in-scene search

  • Embedding matching frees up users from manually traversing their entire scene or database for relevant assets and enables them to locate assets without requiring to be manually tagged

  • USD Search API can index data on a storage backend (for eg. S3, Omniverse Nucleus, and more could be added)

  • Images and any assets with thumbnails can get indexed right away and 3D OpenUSD assets get rendered first from multiple views using Kit-based rendering and then get indexed

System Requirements#

A stable internet connection is sufficient for accessing USD Search API on the API catalog.

Known Limitations#

  • No results returned: Queries, if not confined to commonly found warehouse items, may return no (or arbitrary) results. Descriptive queries are known to yield best results (for eg. “cardboard box”, “traffic cone”, “storage racks”, etc.)

  • Permutations: Permutations of the query may return different results (for eg. query results for “safety cone” and “cone safety” may differ)

On this page