Sync the latest saved KeyShot scene
keyshot_sync_saved_sceneDetects changes in a saved KeyShot .bip scene, copies it to a collision-safe destination, and returns an optional preview render.
Instructions
Find a saved .bip file (or the newest .bip in one folder), detect whether it changed, copy it to a collision-safe output path, and optionally return an Agent-visible preview. This is the stable alternative to unsupported persistent GUI control.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| width | No | Preview width in pixels. Defaults to 960; allowed range is 64 to 1920. | |
| camera | No | Optional saved camera name for the embedded preview. Omit to use the scene's active camera. | |
| height | No | Preview height in pixels. Defaults to 540; allowed range is 64 to 1080. | |
| samples | No | Preview render samples. Defaults to 16 unless maxTimeSeconds is provided; maximum is 64. | |
| sourcePath | Yes | Absolute path to a saved .bip scene or a directory whose newest .bip scene should be synchronized. Directories are searched only at their top level. | |
| includePreview | No | Whether to render and embed a temporary PNG from the synchronized copy. Defaults to true. | |
| maxTimeSeconds | No | Time-based preview limit in seconds. Replaces the default sample mode and cannot be combined with an explicit samples value; maximum is 60. | |
| outputScenePath | No | Optional destination for the synchronized .bip copy inside KEYSHOT_OUTPUT_DIR. Existing explicit paths are never overwritten; when omitted, a collision-safe name is generated. | |
| previousFingerprint | No | Optional fingerprint returned by an earlier sync. When it still matches, no copy or preview is created. |
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. |