Set a KeyShot camera
keyshot_set_cameraSet or update a named camera in a KeyShot scene by specifying position, target, distance, field of view, or focal length, then save the edited scene.
Instructions
Create or update a named camera using position, target, distance, field of view, or focal length, then save the edited scene.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| up | No | Optional camera up direction [x, y, z]. Requires position and lookAt. | |
| lookAt | No | Camera target [x, y, z]. Must be provided together with position. | |
| distance | No | Positive KeyShot camera distance. | |
| position | No | Camera position [x, y, z]. Must be provided together with lookAt. | |
| scenePath | Yes | Absolute path to an existing KeyShot scene file to open. Input files may be outside the configured output directory. | |
| cameraName | No | Saved camera to update, or the name to use when creating a camera. | |
| fieldOfView | No | Field of view in degrees, greater than 0 and less than 180. Cannot be combined with focalLength. | |
| focalLength | No | Focal length from 5 to 200 mm. Cannot be combined with fieldOfView. | |
| 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. |