Get Thumbnail

GET /image/thumbnail/{index}

Get the thumbnail of an image. This requies Create Thumbnails to be enabled in NINA. Otherwise, use the image endpoint and resize the image. This thumbnail has a width of 256px.

Path parameters

  • index integer(int32) Required

    The index of the image to get

Query parameters

  • imageType string

    Filter the image history by image type. This is useful if you got the index of an image using the history with a filter and now want to get the image. E.g. the 3rd flat in the image history is the 3rd flat in the image endpoint.

    Values are LIGHT, FLAT, DARK, BIAS, or SNAPSHOT.

Responses

  • 200 image/jpg

    Successful response

    Image in jpg format, when stream is set to true and the image quality is specified

  • 400 application/json

    No thumbnails available

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
  • 500 application/json

    Internal server error, Unknown error

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
GET /image/thumbnail/{index}
curl \
 --request GET 'http://localhost:1888/v2/api/image/thumbnail/{index}'
Response examples (400)
{
  "Response": "string",
  "Error": "No thumbnails available",
  "StatusCode": 400,
  "Success": false,
  "Type": "API"
}
Response examples (500)
{
  "Response": "string",
  "Error": "Unknown error",
  "StatusCode": 500,
  "Success": false,
  "Type": "API"
}