Apply a KeyShot material
keyshot_apply_materialApply a KeyShot material from the library or a local file to an object, then save the edited scene.
Instructions
Apply a KeyShot library material or local material file to a specific object, then save the edited scene.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| scenePath | Yes | Absolute path to an existing KeyShot scene file to open. Input files may be outside the configured output directory. | |
| objectName | No | Scene object name to modify. Provide either objectName or the more specific objectPath. | |
| objectPath | No | Full scene-tree path of the object to modify. Use this instead of objectName when names are duplicated. | |
| materialName | No | Material name from the local KeyShot library. Provide either materialName or materialPath. | |
| materialPath | No | Absolute path to a local KeyShot material file. Provide either materialPath or materialName. | |
| outputScenePath | Yes | Destination path for the saved KeyShot scene. The path must stay inside KEYSHOT_OUTPUT_DIR unless external outputs are explicitly enabled. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | True when the requested operation completed successfully. | |
| data | No | Operation-specific structured result data, or null when unavailable. | |
| error | Yes | Human-readable failure reason, or null after success. | |
| warnings | Yes | Non-fatal conditions the user or agent should review. | |
| errorCode | No | Stable error category for common failures. | |
| outputFiles | Yes | Absolute paths of images or scene files created by the operation. | |
| suggestions | No | Actionable recovery steps for the user or agent. | |
| keyshotStdoutTail | Yes | Truncated tail of KeyShot headless output for diagnostics. |