Set a KeyShot camera
keyshot_set_cameraCreate or update a named camera using 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.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"scenePath": "<scenePath>",
"outputScenePath": "<outputScenePath>"
},
"name": "keyshot_set_camera"
}
}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. | |
| overwrite | No | Allow replacing an existing output file. Defaults to false. Input files can never be replaced, even when true. | |
| 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 a saved scene copy, never an input file. Existing files are rejected unless overwrite=true. 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 | Yes | 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. |