NINA Image

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

Actions7

Get Image

AI-generated

Summary

Retrieve an image by its index from the N.I.N.A. ninaAPI with optional parameters for image type and image processing settings.

Inputs

  • Index (required) — Zero-based index of the image to retrieve.
  • Image Type — Type of the image to get. Options include Light, Dark, Bias, Flat, Snapshot. Defaults to Light.
  • Resize — Whether to resize the image before retrieval. Default is false.
  • Quality — JPEG quality of the retrieved image, from 1 to 100. Defaults to 90.
  • Size — Image size specification used for resizing.
  • Scale — Scale factor applied to the image.
  • Factor — Factor value affecting the image processing.
  • Black Clipping — Value for black clipping applied to the image.
  • Unlinked — Use unlinked stretch if set to true. Default is false.
  • Debayer — Whether to debayer the image. Default is false.
  • Auto Prepare — Whether to auto prepare the image. Default is true.
  • Bayer Pattern — Override Bayer pattern for debayering.

Output shape

a JSON array containing the retrieved image data or related metadata.

The response is returned as JSON and may consist of a single item or multiple items depending on response. Errors will be returned in an error object. The image is fetched from the ninaAPI endpoint /image/{index} with query parameters to customize image processing.

Examples

Example 1: Retrieve a light image at index 0 with default quality and no resizing.

Set Index to 0, Image Type to Light, Resize to false.

Example 2: Retrieve a dark image at index 2, resized to specific size and quality.

Set Index to 2, Image Type to Dark, Resize to true, Size specified, Quality adjusted, other image processing options as needed.

Links

Discussion