get_prim_properties
Read a single USD prim's type, world transform, bounds, physics flags, API schemas, variant sets, attributes, and relationships to inspect its Omniverse Kit scene state.
Instructions
Get one prim as a prim block: its type, world position and rotation, world bounding box, physics flags, its applied API schemas, its variant sets, every attribute's value, and each relationship with its targets.
Use it to read one prim; get_prim_bounds when only its size and place matter, get_scene_tree to find paths, and with include_properties for many prims at once, written to a file. The rotation, rot, is a quaternion w, x, y, z with any scale taken out; a prim scaled to 0 has none. api_schemas lists the applied API schemas the Kit app knows, a type's built-in ones included, [] for none: PhysicsCollisionAPI for a collider, MaterialBindingAPI for a bound material. variant_sets lists each variant set with its selection (none when there is none), its options, and the layer holding the selection: session (Kit's session layer, which set_variant_selection writes by default), root, or a file's name; [] for no set, such as state: open [closed, open] (session). A relationship gives its targets, such as material:binding = /World/Looks/Red; one with none is left out, as an unset attribute is.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"prim_path": "<prim_path>"
},
"name": "get_prim_properties"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| prim_path | Yes | Full USD path of the prim, e.g. "/World/Robot" |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |