NINA Image

Retrieve and manage images via N.I.N.A. ninaAPI

Get Prepared Image

AI-generated

Summary

Retrieve the currently prepared image from N.I.N.A. with options to modify its appearance and processing before download.

Inputs

  • Resize — Whether to resize the image (default: false).
  • Quality — JPEG quality from 1 to 100 (default: 90).
  • Size — Image size to request (optional).
  • Scale — Scale factor to apply (default: 1).
  • Factor — Factor value affecting image processing (default: 1).
  • Black Clipping — Black clipping value to apply (default: 0).
  • Unlinked — Whether to use unlinked stretch for image contrast (default: false).
  • Debayer — Whether to debayer the image (default: false).
  • Auto Prepare — Whether to automatically prepare the image on the server (default: true).
  • Bayer Pattern — Optional Bayer pattern override for debayering.

Output shape

a JSON object representing the retrieved prepared image data, including any processing applied based on parameters

The output is a single JSON object describing the image. The image data is returned directly from the N.I.N.A. ninaAPI's /prepared-image endpoint with applied query parameters. Errors during retrieval are returned per-item if 'continueOnFail' is enabled.

Examples

Example 1: Get a resized prepared image with 80 quality JPEG

Set Resize to true and Quality to 80, leave other parameters as default, then execute operation 'Get Prepared Image'.

Links

Discussion