Response [200 Ok]

Uri /api/v2/image/4nrJP7s-34
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] - Cheetah and five cubs
/api/v2/image/4nrJP7s-34

Uri /api/v2/image/4nrJP7s-34
UriDescription Image by key
Altitude 0
CanBuy true
CanEdit false
CanShare true
Caption A cheetah with her five cubs posing at sunrise in the Masai Mara, Kenya
Collectable true
Comments true
Date 2017-03-21T00:40:17+00:00
DateTimeOriginal 2006-06-25T14:05:36+00:00
DateTimeUploaded 2017-03-21T00:40:17+00:00
FileName 20060625-069.jpg
Format JPG
Hidden false
ImageKey 4nrJP7s
IsArchive false
IsVideo false
KeywordArray
Array [3]
0 africa
1 kenya
2 masai mara
Keywords africa; kenya; masai mara
LastUpdated 2020-04-06T23:09:01+00:00
Latitude 0.00000000000000
Longitude 0.00000000000000
OriginalHeight 4129
OriginalSize 7769315
OriginalWidth 2753
Processing false
Protected false
Serial 34
ShowKeywords true
ThumbnailUrl https://photos.smugmug.com/photos/i-4nrJP7s/34/Th/i-4nrJP7s-Th.jpg
Title Cheetah and five cubs
UploadKey 5790449711
Watermark No
Watermarked true

Formatted Values

Caption [html, text]

html A cheetah with her five cubs posing at sunrise in the Masai Mara, Kenya
text A cheetah with her five cubs posing at sunrise in the Masai Mara, Kenya

FileName [html, text]

html 20060625-069.jpg
text 20060625-069.jpg

Uris

ImageComments
/api/v2/image/4nrJP7s!comments

Uri /api/v2/image/4nrJP7s!comments
UriDescription Comments on image
EndpointType ImageComments
Locator Comment
LocatorType Objects

ImageMetadata
/api/v2/image/4nrJP7s!metadata

Uri /api/v2/image/4nrJP7s!metadata
UriDescription Metadata for image
EndpointType ImageMetadata
Locator ImageMetadata
LocatorType Object

ImagePricelistExclusions
/api/v2/image/4nrJP7s!pricelistexclusions

Uri /api/v2/image/4nrJP7s!pricelistexclusions
UriDescription Pricelist information for an image
EndpointType ImagePricelistExclusions
Locator ImagePricelistExclusions
LocatorType Object

ImagePrices
/api/v2/image/4nrJP7s!prices

Uri /api/v2/image/4nrJP7s!prices
UriDescription Purchasable Skus
EndpointType ImagePrices
Locator CatalogSkuPrice
LocatorType Objects

ImageSizeDetails
/api/v2/image/4nrJP7s-34!sizedetails

Uri /api/v2/image/4nrJP7s-34!sizedetails
UriDescription Detailed size information for image
EndpointType ImageSizeDetails
Locator ImageSizeDetails
LocatorType Object

ImageSizes
/api/v2/image/4nrJP7s-34!sizes

Uri /api/v2/image/4nrJP7s-34!sizes
UriDescription Sizes available for image
EndpointType ImageSizes
Locator ImageSizes
LocatorType Object

LargestImage
/api/v2/image/4nrJP7s-34!largestimage

Uri /api/v2/image/4nrJP7s-34!largestimage
UriDescription Largest size available for image
EndpointType LargestImage
Locator LargestImage
LocatorType Object

PointOfInterest
/api/v2/image/4nrJP7s!pointofinterest

Uri /api/v2/image/4nrJP7s!pointofinterest
UriDescription Point of interest for image
EndpointType PointOfInterest
Locator PointOfInterest
LocatorType Object

PointOfInterestCrops
/api/v2/image/4nrJP7s!poicrops

Uri /api/v2/image/4nrJP7s!poicrops
UriDescription PointOfInterest Crops for image
EndpointType PointOfInterestCrops
Locator PointOfInterestCrops
LocatorType List

Regions
/api/v2/image/4nrJP7s!regions

Uri /api/v2/image/4nrJP7s!regions
UriDescription Regions for image
EndpointType Regions
Locator Region
LocatorType Objects

Timing

Total

cycles 1
objects 0
time 0.03542

Request

Uri /api/v2/image/4nrJP7s-34
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 boolean
Comments boolean
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
Processing boolean
Protected boolean
Serial integer
ShowKeywords boolean
ThumbnailUrl uri
Title text
UploadKey text
Watermark Deprecated as of 2014-11-20
Watermarked boolean

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/image/4nrJP7s-34"
    },
    "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"
            },
            {
                "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"
            },
            {
                "Name": "IsArchive",
                "Type": "Boolean"
            },
            {
                "Name": "IsVideo",
                "Type": "Boolean"
            },
            {
                "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": "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"
            }
        ],
        "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": "4nrJP7s-34"
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/image/4nrJP7s-34",
        "Locator": "Image",
        "LocatorType": "Object",
        "Image": {
            "Title": "Cheetah and five cubs",
            "Caption": "A cheetah with her five cubs posing at sunrise in the Masai Mara, Kenya",
            "Keywords": "africa; kenya; masai mara",
            "KeywordArray": [
                "africa",
                "kenya",
                "masai mara"
            ],
            "Watermark": "No",
            "Latitude": "0.00000000000000",
            "Longitude": "0.00000000000000",
            "Altitude": 0,
            "Hidden": false,
            "ThumbnailUrl": "https://photos.smugmug.com/photos/i-4nrJP7s/34/Th/i-4nrJP7s-Th.jpg",
            "FileName": "20060625-069.jpg",
            "Processing": false,
            "UploadKey": "5790449711",
            "Date": "2017-03-21T00:40:17+00:00",
            "DateTimeUploaded": "2017-03-21T00:40:17+00:00",
            "DateTimeOriginal": "2006-06-25T14:05:36+00:00",
            "Format": "JPG",
            "OriginalHeight": 4129,
            "OriginalWidth": 2753,
            "OriginalSize": 7769315,
            "LastUpdated": "2020-04-06T23:09:01+00:00",
            "Collectable": true,
            "IsArchive": false,
            "IsVideo": false,
            "CanEdit": false,
            "CanBuy": true,
            "Protected": false,
            "Watermarked": true,
            "ImageKey": "4nrJP7s",
            "Serial": 34,
            "CanShare": true,
            "Comments": true,
            "ShowKeywords": true,
            "FormattedValues": {
                "Caption": {
                    "html": "A cheetah with her five cubs posing at sunrise in the Masai Mara, Kenya",
                    "text": "A cheetah with her five cubs posing at sunrise in the Masai Mara, Kenya"
                },
                "FileName": {
                    "html": "20060625-069.jpg",
                    "text": "20060625-069.jpg"
                }
            },
            "Uri": "/api/v2/image/4nrJP7s-34",
            "UriDescription": "Image by key",
            "Uris": {
                "LargestImage": {
                    "Uri": "/api/v2/image/4nrJP7s-34!largestimage",
                    "Locator": "LargestImage",
                    "LocatorType": "Object",
                    "UriDescription": "Largest size available for image",
                    "EndpointType": "LargestImage"
                },
                "ImageSizes": {
                    "Uri": "/api/v2/image/4nrJP7s-34!sizes",
                    "Locator": "ImageSizes",
                    "LocatorType": "Object",
                    "UriDescription": "Sizes available for image",
                    "EndpointType": "ImageSizes"
                },
                "ImageSizeDetails": {
                    "Uri": "/api/v2/image/4nrJP7s-34!sizedetails",
                    "Locator": "ImageSizeDetails",
                    "LocatorType": "Object",
                    "UriDescription": "Detailed size information for image",
                    "EndpointType": "ImageSizeDetails"
                },
                "PointOfInterest": {
                    "Uri": "/api/v2/image/4nrJP7s!pointofinterest",
                    "Locator": "PointOfInterest",
                    "LocatorType": "Object",
                    "UriDescription": "Point of interest for image",
                    "EndpointType": "PointOfInterest"
                },
                "PointOfInterestCrops": {
                    "Uri": "/api/v2/image/4nrJP7s!poicrops",
                    "Locator": "PointOfInterestCrops",
                    "LocatorType": "List",
                    "UriDescription": "PointOfInterest Crops for image",
                    "EndpointType": "PointOfInterestCrops"
                },
                "Regions": {
                    "Uri": "/api/v2/image/4nrJP7s!regions",
                    "Locator": "Region",
                    "LocatorType": "Objects",
                    "UriDescription": "Regions for image",
                    "EndpointType": "Regions"
                },
                "ImageComments": {
                    "Uri": "/api/v2/image/4nrJP7s!comments",
                    "Locator": "Comment",
                    "LocatorType": "Objects",
                    "UriDescription": "Comments on image",
                    "EndpointType": "ImageComments"
                },
                "ImageMetadata": {
                    "Uri": "/api/v2/image/4nrJP7s!metadata",
                    "Locator": "ImageMetadata",
                    "LocatorType": "Object",
                    "UriDescription": "Metadata for image",
                    "EndpointType": "ImageMetadata"
                },
                "ImagePrices": {
                    "Uri": "/api/v2/image/4nrJP7s!prices",
                    "Locator": "CatalogSkuPrice",
                    "LocatorType": "Objects",
                    "UriDescription": "Purchasable Skus",
                    "EndpointType": "ImagePrices"
                },
                "ImagePricelistExclusions": {
                    "Uri": "/api/v2/image/4nrJP7s!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.03542,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}

Contents

  1. Response
  2. Request
  3. Config
  4. Options
    1. Notes
    2. Methods
    3. Available Media Types
    4. Output Fields
  5. JSON