Render one KeyShot view
keyshot_renderRender the active or a named camera from an existing KeyShot scene to an image file, with configurable resolution, format, quality, and render time.
Instructions
Render the active or a named camera from an existing scene to an image file.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| width | No | Render width in pixels. Overrides the selected quality preset when provided. | |
| camera | No | Optional saved camera name to activate before rendering. Omit to use the scene's active camera. | |
| format | No | Output image format. Defaults to PNG when omitted. | |
| height | No | Render height in pixels. Overrides the selected quality preset when provided. | |
| samples | No | Maximum render samples. Cannot be combined with maxTimeSeconds and overrides preset sampling when provided. | |
| scenePath | Yes | Absolute path to an existing KeyShot scene file to open. Input files may be outside the configured output directory. | |
| outputPath | No | Destination image path. When omitted, a PNG name is generated inside KEYSHOT_OUTPUT_DIR. | |
| qualityPreset | No | Render quality preset: preview (960x540, 16 samples), standard (1920x1080, 64 samples), or final (3840x2160, 256 samples). | |
| maxTimeSeconds | No | Maximum render time in seconds. Selects time-based rendering and cannot be combined with samples. |
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. |