NINA Image

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

Actions7

Set Image Prefix

AI-generated

Summary

Set the file prefix for a specific image by providing its index and the desired prefix string.

Inputs

  • Index (required) — The zero-based index of the image to modify.
  • Prefix (required) — The file prefix string to add to the image filename.
  • Image Type (required) — The category/type of the image (Light, Dark, Bias, Flat, Snapshot); defaults to 'Light'.

Output shape

a JSON object indicating the result of setting the prefix for the specified image.

The operation sends a GET request to set the prefix and returns the API response wrapped in standard execution metadata. No pagination is involved.

Examples

Example 1: Set the prefix 'New_' for the light image at index 0.

Index=0, Prefix='New_', Image Type='Light'

Links

Discussion