Import a model into KeyShot
keyshot_import_modelImport a supported local 3D model into a KeyShot scene, apply composition options such as centering or ground snap, and save the new scene.
Instructions
Import a supported local model into an empty or base scene, apply requested composition options, and save a new scene.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| modelPath | Yes | Absolute path to a model file supported by KeyShot, such as OBJ, FBX, STL, or glTF. | |
| snapToGround | No | Ask KeyShot to place imported geometry on the ground plane when supported. | |
| baseScenePath | No | Optional existing KeyShot scene to use as the import base. Omit to start from an empty scene. | |
| centerGeometry | No | Ask KeyShot to center imported geometry during import when supported. | |
| outputScenePath | Yes | Destination path for the saved KeyShot scene. The path must stay inside KEYSHOT_OUTPUT_DIR unless external outputs are explicitly enabled. | |
| adjustEnvironment | No | Ask KeyShot to adjust the environment to the imported geometry when supported. | |
| adjustCameraLookAt | No | Ask KeyShot to retarget the active camera to the imported geometry when supported. |
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. |