Response [200 Ok]

Uri /api/v2/image/nPGBtpJ-0
UriDescription Image by key
DocUri https://api.smugmug.com/api/v2/doc/reference/image.html
EndpointType Image
Locator Image
LocatorType Object

Image [1 of 1]
/api/v2/image/nPGBtpJ-0

Uri /api/v2/image/nPGBtpJ-0
UriDescription Image by key
Altitude 0
ArchivedMD5 5b98386f9af0940e3c698cb7d0af2a9a
ArchivedSize 3055405
ArchivedUri https://photos.smugmug.com/Sample-Photos-for-Trials/Sample-Photos/i-nPGBtpJ/0/MK4q76gkTWfKLjGs77hmnZv3xD96mCf6rXSPMjxtd/D/_DSC4321-D.jpg
CanBuy false
CanEdit false
CanShare false
Caption empty string
Collectable true
Comments false
ComponentFileTypes
Date 2020-04-21T05:57:24+00:00
DateTimeOriginal 2014-12-31T23:03:54+00:00
DateTimeUploaded 2020-04-21T05:57:24+00:00
EZProject false
FileName _DSC4321.jpg
Format JPG
Hidden false
ImageKey nPGBtpJ
IsArchive false
IsVideo false
KeywordArray
Array [48]
0 2014
1 30 Rockefeller Plaza
2 Aaron Meyers Photography
3 Art Deco
4 Comcast Building
5 D800
6 Empire state
7 Empire state building
8 GE
9 GE Building
10 Manhattan
11 NYC
12 NYE
13 NYE 2015
14 NYE2015
15 New York
16 New York City
17 Nikon
18 Nikon D800
19 RCA Building
20 Rainbow Room
21 Raymond Hood
22 Rockefeller
23 Rockefeller Plaza
24 The Ball
25 WTC
26 ball
27 ball drop
28 blue hour
29 building
30 city
31 cityscape
32 colors
33 drop
34 empire
35 hm sunset
36 lights
37 new year
38 new years
39 new years eve
40 observation deck
41 rockefeller center
42 skyline
43 skyscraper
44 the rock
45 times square
46 top of the rock
47 world trade center
Keywords 2014; 30 Rockefeller Plaza; Aaron Meyers Photography; Art Deco; Comcast Building; D800; Empire state; Empire state building; GE; GE Building; Manhattan; NYC; NYE; NYE 2015; NYE2015; New York; New York City; Nikon; Nikon D800; RCA Building; Rainbow Room; Raymond Hood; Rockefeller; Rockefeller Plaza; The Ball; WTC; ball; ball drop; blue hour; building; city; cityscape; colors; drop; empire; hm sunset; lights; new year; new years; new years eve; observation deck; rockefeller center; skyline; skyscraper; the rock; times square; top of the rock; world trade center
LastUpdated 2020-04-21T05:57:31+00:00
Latitude 40.758983333333
Longitude -73.979344444444
OriginalHeight 3419
OriginalSize 3055405
OriginalWidth 5120
PreferredDisplayFileExtension JPG
Processing false
Protected false
Serial 0
ShowKeywords true
Status Open
SubStatus NFS
ThumbnailUrl https://photos.smugmug.com/Sample-Photos-for-Trials/Sample-Photos/i-nPGBtpJ/0/L5xhK88X3WqQkTn4C6VtGKTVfhcg44868kMKdZnds/Th/_DSC4321-Th.jpg
Title empty string
UploadKey 9415440810
Watermark No
Watermarked false

Formatted Values

Caption [html, text]

html empty string
text empty string

FileName [html, text]

html _DSC4321.jpg
text _DSC4321.jpg

Uris

ImageMetadata
/api/v2/image/nPGBtpJ-0!metadata

Uri /api/v2/image/nPGBtpJ-0!metadata
UriDescription Metadata for image
EndpointType ImageMetadata
Locator ImageMetadata
LocatorType Object

ImagePricelistExclusions
/api/v2/image/nPGBtpJ-0!pricelistexclusions

Uri /api/v2/image/nPGBtpJ-0!pricelistexclusions
UriDescription Pricelist information for an image
EndpointType ImagePricelistExclusions
Locator ImagePricelistExclusions
LocatorType Object

ImagePrices
/api/v2/image/nPGBtpJ-0!prices

Uri /api/v2/image/nPGBtpJ-0!prices
UriDescription Purchasable Skus
EndpointType ImagePrices
Locator CatalogSkuPrice
LocatorType Objects

ImageSizeDetails
/api/v2/image/nPGBtpJ-0!sizedetails

Uri /api/v2/image/nPGBtpJ-0!sizedetails
UriDescription Detailed size information for image
EndpointType ImageSizeDetails
Locator ImageSizeDetails
LocatorType Object

ImageSizes
/api/v2/image/nPGBtpJ-0!sizes

Uri /api/v2/image/nPGBtpJ-0!sizes
UriDescription Sizes available for image
EndpointType ImageSizes
Locator ImageSizes
LocatorType Object

LargestImage
/api/v2/image/nPGBtpJ-0!largestimage

Uri /api/v2/image/nPGBtpJ-0!largestimage
UriDescription Largest size available for image
EndpointType LargestImage
Locator LargestImage
LocatorType Object

PointOfInterest
/api/v2/image/nPGBtpJ-0!pointofinterest

Uri /api/v2/image/nPGBtpJ-0!pointofinterest
UriDescription Point of interest for image
EndpointType PointOfInterest
Locator PointOfInterest
LocatorType Object

PointOfInterestCrops
/api/v2/image/nPGBtpJ-0!poicrops

Uri /api/v2/image/nPGBtpJ-0!poicrops
UriDescription PointOfInterest Crops for image
EndpointType PointOfInterestCrops
Locator PointOfInterestCrops
LocatorType List

Regions
/api/v2/image/nPGBtpJ-0!regions

Uri /api/v2/image/nPGBtpJ-0!regions
UriDescription Regions for image
EndpointType Regions
Locator Region
LocatorType Objects

Timing

Total

cycles 1
objects 0
time 0.05184

Request

Uri /api/v2/image/nPGBtpJ-0
Method GET
Version v2

Config

{
    "expand_method": "ref",
    "shorturis": false
}

Options

Path

  • /api
  • /v2
  • /image
  • /

Notes

  • The Uri returned by this endpoint may not exist if it was recently uploaded and is being processed
  • "Watermark" has been deprecated in favor of "Watermarked". "Watermarked" will only be present for images with a known watermarked state
  • Photo sizes, including Original, without a "Size" or "MD5" property, will be generated dynamically upon request
  • "ArchivedUri", "ArchivedSize" and "ArchivedMD5" refer to the untouched version of the photo originally uploaded

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

PATCH

Permissions
  • Modify

DELETE

Permissions
  • Modify

Output Fields

Altitude integer
ArchivedMD5 text
ArchivedSize integer
ArchivedUri uri
CanBuy boolean
CanEdit boolean
CanShare boolean
Caption text
Collectable Deprecated as of 2022-03-09
Comments boolean
ComponentFileTypes hash
Date Deprecated as of 2020-07-17 Use DateTimeUploaded
DateTimeOriginal datetimeiso8601
DateTimeUploaded datetimeiso8601
EZProject boolean
FileName text
Format text
FormattedValues hash Alternative versions of certain fields formatted for use in different contexts.
Hidden boolean
ImageKey text
IsArchive boolean
IsVideo boolean
KeywordArray array
Keywords text
LastUpdated datetimeiso8601
Latitude decimal
Longitude decimal
OriginalHeight integer
OriginalSize integer
OriginalWidth integer
PreferredDisplayFileExtension text Preferred file extension that should be used when displaying this image. If this Image is backed by an Asset with components these will be used for this calculation.
Processing boolean
Protected boolean
Serial integer
ShowKeywords boolean
Status text
SubStatus text
ThumbnailUrl uri
Title text
UploadKey Deprecated as of 2022-03-10
Watermark Deprecated as of 2014-11-20
Watermarked boolean

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/image/nPGBtpJ-0"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            },
            "PATCH": {
                "Permissions": [
                    "Modify"
                ]
            },
            "DELETE": {
                "Permissions": [
                    "Modify"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET"
        ],
        "MediaTypes": [
            "application/json",
            "application/vnd.php.serialized",
            "application/x-msgpack",
            "text/html",
            "text/csv"
        ],
        "Output": [
            {
                "Name": "Title",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "Caption",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "Keywords",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "KeywordArray",
                "Type": "Array",
                "ITEM_TYPE": "Varchar",
                "MIN_COUNT": 0,
                "MAX_COUNT": "INFINITY"
            },
            {
                "Name": "Watermark",
                "Type": "Select",
                "OPTIONS": [
                    "No",
                    "Yes",
                    "Inherit from Album"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1,
                "Deprecated": "2014-11-20"
            },
            {
                "Name": "Latitude",
                "Type": "DECIMAL",
                "PRECISION": 16,
                "SCALE": 14,
                "SIGNED": true
            },
            {
                "Name": "Longitude",
                "Type": "DECIMAL",
                "PRECISION": 17,
                "SCALE": 14,
                "SIGNED": true
            },
            {
                "Name": "Altitude",
                "Type": "Integer",
                "MIN_VALUE": 0,
                "MAX_VALUE": 16777215
            },
            {
                "Name": "Hidden",
                "Type": "Boolean"
            },
            {
                "Name": "ThumbnailUrl",
                "Type": "Uri",
                "MAX_LENGTH": "INFINITY",
                "Locator": []
            },
            {
                "Name": "FileName",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "Processing",
                "Type": "Boolean"
            },
            {
                "Name": "UploadKey",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY",
                "Deprecated": "2022-03-10"
            },
            {
                "Name": "Date",
                "Description": "Use DateTimeUploaded",
                "Type": "DateTimeISO8601",
                "Deprecated": "2020-07-17"
            },
            {
                "Name": "DateTimeUploaded",
                "Type": "DateTimeISO8601"
            },
            {
                "Name": "DateTimeOriginal",
                "Type": "DateTimeISO8601"
            },
            {
                "Name": "Format",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "OriginalHeight",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "OriginalWidth",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "OriginalSize",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "LastUpdated",
                "Type": "DateTimeISO8601"
            },
            {
                "Name": "Collectable",
                "Type": "Boolean",
                "Deprecated": "2022-03-09"
            },
            {
                "Name": "IsArchive",
                "Type": "Boolean"
            },
            {
                "Name": "IsVideo",
                "Type": "Boolean"
            },
            {
                "Name": "ComponentFileTypes",
                "Type": "Hash"
            },
            {
                "Name": "CanEdit",
                "Type": "Boolean"
            },
            {
                "Name": "CanBuy",
                "Type": "Boolean"
            },
            {
                "Name": "Protected",
                "Type": "Boolean"
            },
            {
                "Name": "EZProject",
                "Type": "Boolean"
            },
            {
                "Name": "Watermarked",
                "Type": "Boolean"
            },
            {
                "Name": "ImageKey",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "Serial",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "ArchivedUri",
                "Type": "Uri",
                "MAX_LENGTH": "INFINITY",
                "Locator": []
            },
            {
                "Name": "ArchivedSize",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "ArchivedMD5",
                "Type": "Text",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "Status",
                "Type": "Text",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "SubStatus",
                "Type": "Text",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "CanShare",
                "Type": "Boolean"
            },
            {
                "Name": "Comments",
                "Type": "Boolean"
            },
            {
                "Name": "ShowKeywords",
                "Type": "Boolean"
            },
            {
                "Name": "FormattedValues",
                "Description": "Alternative versions of certain fields formatted for use in different contexts.",
                "Type": "Hash"
            },
            {
                "Name": "PreferredDisplayFileExtension",
                "Description": "Preferred file extension that should be used when displaying this image. If this Image is backed by an Asset with components these will be used for this calculation.",
                "Type": "Text",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            }
        ],
        "Notes": [
            "The Uri returned by this endpoint may not exist if it was recently uploaded and is being processed",
            "\"Watermark\" has been deprecated in favor of \"Watermarked\".\n        \"Watermarked\" will only be present for images with a known watermarked state",
            "Photo sizes, including Original, without a \"Size\" or \"MD5\" property, will be generated dynamically upon request",
            "\"ArchivedUri\", \"ArchivedSize\" and \"ArchivedMD5\" refer to the untouched version of the photo originally uploaded"
        ],
        "Path": [
            {
                "type": "path",
                "text": "api"
            },
            {
                "type": "path",
                "text": "v2"
            },
            {
                "type": "path",
                "text": "image"
            },
            {
                "type": "singleparam",
                "param_name": "imagekey",
                "param_value": "nPGBtpJ-0",
                "param_validator": {}
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/image/nPGBtpJ-0",
        "Locator": "Image",
        "LocatorType": "Object",
        "Image": {
            "Title": "",
            "Caption": "",
            "Keywords": "2014; 30 Rockefeller Plaza; Aaron Meyers Photography; Art Deco; Comcast Building; D800; Empire state; Empire state building; GE; GE Building; Manhattan; NYC; NYE; NYE 2015; NYE2015; New York; New York City; Nikon; Nikon D800; RCA Building; Rainbow Room; Raymond Hood; Rockefeller; Rockefeller Plaza; The Ball; WTC; ball; ball drop; blue hour; building; city; cityscape; colors; drop; empire; hm sunset; lights; new year; new years; new years eve; observation deck; rockefeller center; skyline; skyscraper; the rock; times square; top of the rock; world trade center",
            "KeywordArray": [
                "2014",
                "30 Rockefeller Plaza",
                "Aaron Meyers Photography",
                "Art Deco",
                "Comcast Building",
                "D800",
                "Empire state",
                "Empire state building",
                "GE",
                "GE Building",
                "Manhattan",
                "NYC",
                "NYE",
                "NYE 2015",
                "NYE2015",
                "New York",
                "New York City",
                "Nikon",
                "Nikon D800",
                "RCA Building",
                "Rainbow Room",
                "Raymond Hood",
                "Rockefeller",
                "Rockefeller Plaza",
                "The Ball",
                "WTC",
                "ball",
                "ball drop",
                "blue hour",
                "building",
                "city",
                "cityscape",
                "colors",
                "drop",
                "empire",
                "hm sunset",
                "lights",
                "new year",
                "new years",
                "new years eve",
                "observation deck",
                "rockefeller center",
                "skyline",
                "skyscraper",
                "the rock",
                "times square",
                "top of the rock",
                "world trade center"
            ],
            "Watermark": "No",
            "Latitude": "40.758983333333",
            "Longitude": "-73.979344444444",
            "Altitude": 0,
            "Hidden": false,
            "ThumbnailUrl": "https://photos.smugmug.com/Sample-Photos-for-Trials/Sample-Photos/i-nPGBtpJ/0/L5xhK88X3WqQkTn4C6VtGKTVfhcg44868kMKdZnds/Th/_DSC4321-Th.jpg",
            "FileName": "_DSC4321.jpg",
            "Processing": false,
            "UploadKey": "9415440810",
            "Date": "2020-04-21T05:57:24+00:00",
            "DateTimeUploaded": "2020-04-21T05:57:24+00:00",
            "DateTimeOriginal": "2014-12-31T23:03:54+00:00",
            "Format": "JPG",
            "OriginalHeight": 3419,
            "OriginalWidth": 5120,
            "OriginalSize": 3055405,
            "LastUpdated": "2020-04-21T05:57:31+00:00",
            "Collectable": true,
            "IsArchive": false,
            "IsVideo": false,
            "ComponentFileTypes": [],
            "CanEdit": false,
            "CanBuy": false,
            "Protected": false,
            "EZProject": false,
            "Watermarked": false,
            "ImageKey": "nPGBtpJ",
            "Serial": 0,
            "ArchivedUri": "https://photos.smugmug.com/Sample-Photos-for-Trials/Sample-Photos/i-nPGBtpJ/0/MK4q76gkTWfKLjGs77hmnZv3xD96mCf6rXSPMjxtd/D/_DSC4321-D.jpg",
            "ArchivedSize": 3055405,
            "ArchivedMD5": "5b98386f9af0940e3c698cb7d0af2a9a",
            "Status": "Open",
            "SubStatus": "NFS",
            "CanShare": false,
            "Comments": false,
            "ShowKeywords": true,
            "FormattedValues": {
                "Caption": {
                    "html": "",
                    "text": ""
                },
                "FileName": {
                    "html": "_DSC4321.jpg",
                    "text": "_DSC4321.jpg"
                }
            },
            "PreferredDisplayFileExtension": "JPG",
            "Uri": "/api/v2/image/nPGBtpJ-0",
            "UriDescription": "Image by key",
            "Uris": {
                "LargestImage": {
                    "Uri": "/api/v2/image/nPGBtpJ-0!largestimage",
                    "Locator": "LargestImage",
                    "LocatorType": "Object",
                    "UriDescription": "Largest size available for image",
                    "EndpointType": "LargestImage"
                },
                "ImageSizes": {
                    "Uri": "/api/v2/image/nPGBtpJ-0!sizes",
                    "Locator": "ImageSizes",
                    "LocatorType": "Object",
                    "UriDescription": "Sizes available for image",
                    "EndpointType": "ImageSizes"
                },
                "ImageSizeDetails": {
                    "Uri": "/api/v2/image/nPGBtpJ-0!sizedetails",
                    "Locator": "ImageSizeDetails",
                    "LocatorType": "Object",
                    "UriDescription": "Detailed size information for image",
                    "EndpointType": "ImageSizeDetails"
                },
                "PointOfInterest": {
                    "Uri": "/api/v2/image/nPGBtpJ-0!pointofinterest",
                    "Locator": "PointOfInterest",
                    "LocatorType": "Object",
                    "UriDescription": "Point of interest for image",
                    "EndpointType": "PointOfInterest"
                },
                "PointOfInterestCrops": {
                    "Uri": "/api/v2/image/nPGBtpJ-0!poicrops",
                    "Locator": "PointOfInterestCrops",
                    "LocatorType": "List",
                    "UriDescription": "PointOfInterest Crops for image",
                    "EndpointType": "PointOfInterestCrops"
                },
                "Regions": {
                    "Uri": "/api/v2/image/nPGBtpJ-0!regions",
                    "Locator": "Region",
                    "LocatorType": "Objects",
                    "UriDescription": "Regions for image",
                    "EndpointType": "Regions"
                },
                "ImageMetadata": {
                    "Uri": "/api/v2/image/nPGBtpJ-0!metadata",
                    "Locator": "ImageMetadata",
                    "LocatorType": "Object",
                    "UriDescription": "Metadata for image",
                    "EndpointType": "ImageMetadata"
                },
                "ImagePrices": {
                    "Uri": "/api/v2/image/nPGBtpJ-0!prices",
                    "Locator": "CatalogSkuPrice",
                    "LocatorType": "Objects",
                    "UriDescription": "Purchasable Skus",
                    "EndpointType": "ImagePrices"
                },
                "ImagePricelistExclusions": {
                    "Uri": "/api/v2/image/nPGBtpJ-0!pricelistexclusions",
                    "Locator": "ImagePricelistExclusions",
                    "LocatorType": "Object",
                    "UriDescription": "Pricelist information for an image",
                    "EndpointType": "ImagePricelistExclusions"
                }
            }
        },
        "UriDescription": "Image by key",
        "EndpointType": "Image",
        "DocUri": "https://api.smugmug.com/api/v2/doc/reference/image.html",
        "Timing": {
            "Total": {
                "time": 0.05184,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}