Resource Guide

Images

Images are the entry point for browsing many NiftyImages assets, including maps through the type=map filter.

Every image response is scoped to the authenticated account. Unknown ids, cross-account ids, and unsupported image URLs return 404 rather than leaking resource existence.

List image types

Reference

Discover the valid values for the type filter before listing images.

curl https://dev.niftyimages.com/v2/image-types \
  -H "Authorization: Bearer $NIFTYIMAGES_API_KEY"

List images

Reference

Browse images with cursor pagination. Use status, type, and q to narrow the result set.

curl "https://dev.niftyimages.com/v2/images?limit=20&status=active" \
  -H "Authorization: Bearer $NIFTYIMAGES_API_KEY"

Filter images by type

Reference

Use a discovered image type to list a specific product surface. Maps are returned with the map image type.

curl "https://dev.niftyimages.com/v2/images?type=map" \
  -H "Authorization: Bearer $NIFTYIMAGES_API_KEY"

Get an image

Reference

Fetch one image by id. Active images include their production URL and a short-lived thumbnail URL.

curl https://dev.niftyimages.com/v2/images/418344 \
  -H "Authorization: Bearer $NIFTYIMAGES_API_KEY"

Rename an image

Reference

Update the image name. This endpoint only edits the name field.

curl -X PATCH https://dev.niftyimages.com/v2/images/418344 \
  -H "Authorization: Bearer $NIFTYIMAGES_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Spring launch hero" }'

Delete an image

Reference

Soft-delete an image. The operation is idempotent and returns no content when the image is already deleted.

curl -X DELETE https://dev.niftyimages.com/v2/images/418344 \
  -H "Authorization: Bearer $NIFTYIMAGES_API_KEY"

Restore an image

Reference

Restore a soft-deleted image to the root folder. Restoring an already-active image is a no-op.

curl -X POST https://dev.niftyimages.com/v2/images/418344/restore \
  -H "Authorization: Bearer $NIFTYIMAGES_API_KEY"

Look up an image by URL

Reference

Resolve a production NiftyImages URL back to its image detail response. Parse failures, bad checksums, and cross-account URLs return 404.

curl -X POST https://dev.niftyimages.com/v2/images/lookup \
  -H "Authorization: Bearer $NIFTYIMAGES_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "url": "https://img1.niftyimages.com/example/path.png" }'

Serve an image thumbnail

Reference

Active image list and detail responses include a short-lived anonymous thumbnailUrl. Clients usually follow that URL directly instead of constructing it.

curl "https://dev.niftyimages.com/v2/image-thumbnails/{token}/418344"