preview_image
Retrieve an orientation-corrected preview and size metadata for a dataset image. Specify dataset ID and relative image path, with optional max width, max height, and upscale controls.
Instructions
Return an orientation-corrected preview and size metadata.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| max_width | No | Optional requested width limit. | |
| dataset_id | Yes | Owning dataset identifier. | |
| image_path | Yes | Dataset-relative source image path. | |
| max_height | No | Optional requested height limit. | |
| allow_upscale | No | Whether a small image may be enlarged. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | No | ||
| data | Yes | Describe an orientation-corrected image preview. |