Render selected cameras
keyshot_batch_renderRender a specified list of saved cameras from one KeyShot scene into an output directory, with configurable image format, resolution, sampling, and quality presets.
Instructions
Render an explicit list of saved cameras from one scene into an output directory.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| width | No | Render width in pixels. Overrides the selected quality preset when provided. | |
| format | No | Output image format. Defaults to PNG when omitted. | |
| height | No | Render height in pixels. Overrides the selected quality preset when provided. | |
| cameras | Yes | Saved camera names to render in order. Use keyshot_list_cameras first when names are unknown. | |
| samples | No | Maximum render samples. Cannot be combined with maxTimeSeconds and overrides preset sampling when provided. | |
| outputDir | Yes | Directory for generated render files. Relative paths resolve inside KEYSHOT_OUTPUT_DIR; external paths are rejected by default. | |
| overwrite | No | Whether existing image files may be replaced. Defaults to false. | |
| scenePath | Yes | Absolute path to an existing KeyShot scene file to open. Input files may be outside the configured output directory. | |
| 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. |