NINA Image

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

Actions7

Get Image History

AI-generated

Summary

Retrieve image history entries filtered by image type, optionally returning all images or a specific history index.

Inputs

  • Image Type (required) — Select the type of images to retrieve from history (Light, Dark, Bias, Flat, or Snapshot). Defaults to Light.
  • All Images — Boolean flag to return all images in the history instead of just one. Defaults to false.
  • History Index — Specify a particular image index in the history to retrieve. Ignored if 'All Images' is true.

Output shape

a list of image history entries or a single entry in JSON format

The output is an array of objects representing image history metadata matching the filter parameters. If 'All Images' is true, returns all entries; if a 'History Index' is specified, returns the entry at that index; otherwise, returns default entries. Errors return an error message object.

Examples

Example 1: Retrieve all stored images of type 'Dark'

Set 'Image Type' to Dark and enable 'All Images'. Outputs all dark image history entries.

Example 2: Retrieve the image history entry at index 2 for 'Light' images

Set 'Image Type' to Light and 'History Index' to 2, leave 'All Images' disabled. Outputs the specific entry at index 2.

Links

Discussion