Set the KeyShot environment
keyshot_set_environmentSet a KeyShot scene's environment from library or local file, adjust brightness and rotation, then save the edited scene.
Instructions
Select an environment by library name or local file, optionally change brightness and rotation, and save the edited scene.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rotation | No | Environment rotation in degrees, from 0 inclusive to 360 exclusive. | |
| scenePath | Yes | Absolute path to an existing KeyShot scene file to open. Input files may be outside the configured output directory. | |
| brightness | No | Positive brightness multiplier for the active environment. | |
| environmentName | No | Environment name from the KeyShot library. Cannot be combined with environmentPath. | |
| environmentPath | No | Absolute path to a local KeyShot environment file. Cannot be combined with environmentName. | |
| 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. |