Response [200 Ok]

Uri /api/v2/image/2kV4HpM-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] - Browsing photos on your phone
/api/v2/image/2kV4HpM-0

Uri /api/v2/image/2kV4HpM-0
UriDescription Image by key
Altitude 0
ArchivedMD5 9f15561b4132197fa366d8de3313ca8c
ArchivedSize 3397642
ArchivedUri https://photos.smugmug.com/Sample-Photos-for-Trials/Sample-Photos/i-2kV4HpM/0/NgDn5PR9nB4XMzRQRKNJxCx8VNFtvQRzSjMv6BJC8/D/_DSC6392-D.jpg
CanBuy false
CanEdit false
CanShare false
Caption Your photos on SmugMug will look great on any device. Just open your phone and navigate to the address sent to you in your welcome email. Also download the "SmugMug" iOS or Android app for even better viewing and managing your photos. (Photo by Aaron Meyers)
Collectable true
Comments false
ComponentFileTypes
Date 2020-04-21T05:57:34+00:00
DateTimeOriginal 2018-11-23T01:17:34+00:00
DateTimeUploaded 2020-04-21T05:57:34+00:00
EZProject false
FileName _DSC6392.jpg
Format JPG
Hidden false
ImageKey 2kV4HpM
IsArchive false
IsVideo false
KeywordArray
Array [26]
0 2018
1 Aaron Meyers Photography
2 Bay Area
3 California
4 Chocolate
5 D850
6 Family
7 Holiday
8 Nikon
9 Nikon D850
10 Portola Valley
11 Tday
12 Thanksgiving
13 bourbon
14 bourbon pecan pie truffles
15 chocolate truffles
16 dark chocolate
17 dinner
18 food
19 friends
20 onboardingsamplephoto
21 pecan
22 pie
23 samplephoto
24 truffles
25 turkey
Keywords 2018; Aaron Meyers Photography; Bay Area; California; Chocolate; D850; Family; Holiday; Nikon; Nikon D850; Portola Valley; Tday; Thanksgiving; bourbon; bourbon pecan pie truffles; chocolate truffles; dark chocolate; dinner; food; friends; onboardingsamplephoto; pecan; pie; samplephoto; truffles; turkey
LastUpdated 2020-04-21T05:57:35+00:00
Latitude 0
Longitude 0
OriginalHeight 2724
OriginalSize 3397642
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-2kV4HpM/0/LhWJwVtkwxRgGk8vtpg8WPSqqb3jnGzfMPbFX9v8q/Th/_DSC6392-Th.jpg
Title Browsing photos on your phone
UploadKey 9415440948
Watermark No
Watermarked false

Formatted Values

Caption [html, text]

html Your photos on SmugMug will look great on any device. Just open your phone and navigate to the address sent to you in your welcome email. Also download the "SmugMug" iOS or Android app for even better viewing and managing your photos.<br /> <br /> (Photo by Aaron Meyers)
text Your photos on SmugMug will look great on any device. Just open your phone and navigate to the address sent to you in your welcome email. Also download the "SmugMug" iOS or Android app for even better viewing and managing your photos. (Photo by Aaron Meyers)

FileName [html, text]

html _DSC6392.jpg
text _DSC6392.jpg

Uris

ImageMetadata
/api/v2/image/2kV4HpM-0!metadata

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

ImagePricelistExclusions
/api/v2/image/2kV4HpM-0!pricelistexclusions

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

ImagePrices
/api/v2/image/2kV4HpM-0!prices

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

ImageSizeDetails
/api/v2/image/2kV4HpM-0!sizedetails

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

ImageSizes
/api/v2/image/2kV4HpM-0!sizes

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

LargestImage
/api/v2/image/2kV4HpM-0!largestimage

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

PointOfInterest
/api/v2/image/2kV4HpM-0!pointofinterest

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

PointOfInterestCrops
/api/v2/image/2kV4HpM-0!poicrops

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

Regions
/api/v2/image/2kV4HpM-0!regions

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

Timing

Total

cycles 1
objects 0
time 0.05734

Request

Uri /api/v2/image/2kV4HpM-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/2kV4HpM-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": "2kV4HpM-0",
                "param_validator": {}
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/image/2kV4HpM-0",
        "Locator": "Image",
        "LocatorType": "Object",
        "Image": {
            "Title": "Browsing photos on your phone",
            "Caption": "Your photos on SmugMug will look great on any device. Just open your phone and navigate to the address sent to you in your welcome email. Also download the \"SmugMug\" iOS or Android app for even better viewing and managing your photos.\n\n(Photo by Aaron Meyers)",
            "Keywords": "2018; Aaron Meyers Photography; Bay Area; California; Chocolate; D850; Family; Holiday; Nikon; Nikon D850; Portola Valley; Tday; Thanksgiving; bourbon; bourbon pecan pie truffles; chocolate truffles; dark chocolate; dinner; food; friends; onboardingsamplephoto; pecan; pie; samplephoto; truffles; turkey",
            "KeywordArray": [
                "2018",
                "Aaron Meyers Photography",
                "Bay Area",
                "California",
                "Chocolate",
                "D850",
                "Family",
                "Holiday",
                "Nikon",
                "Nikon D850",
                "Portola Valley",
                "Tday",
                "Thanksgiving",
                "bourbon",
                "bourbon pecan pie truffles",
                "chocolate truffles",
                "dark chocolate",
                "dinner",
                "food",
                "friends",
                "onboardingsamplephoto",
                "pecan",
                "pie",
                "samplephoto",
                "truffles",
                "turkey"
            ],
            "Watermark": "No",
            "Latitude": "0",
            "Longitude": "0",
            "Altitude": 0,
            "Hidden": false,
            "ThumbnailUrl": "https://photos.smugmug.com/Sample-Photos-for-Trials/Sample-Photos/i-2kV4HpM/0/LhWJwVtkwxRgGk8vtpg8WPSqqb3jnGzfMPbFX9v8q/Th/_DSC6392-Th.jpg",
            "FileName": "_DSC6392.jpg",
            "Processing": false,
            "UploadKey": "9415440948",
            "Date": "2020-04-21T05:57:34+00:00",
            "DateTimeUploaded": "2020-04-21T05:57:34+00:00",
            "DateTimeOriginal": "2018-11-23T01:17:34+00:00",
            "Format": "JPG",
            "OriginalHeight": 2724,
            "OriginalWidth": 5120,
            "OriginalSize": 3397642,
            "LastUpdated": "2020-04-21T05:57:35+00:00",
            "Collectable": true,
            "IsArchive": false,
            "IsVideo": false,
            "ComponentFileTypes": [],
            "CanEdit": false,
            "CanBuy": false,
            "Protected": false,
            "EZProject": false,
            "Watermarked": false,
            "ImageKey": "2kV4HpM",
            "Serial": 0,
            "ArchivedUri": "https://photos.smugmug.com/Sample-Photos-for-Trials/Sample-Photos/i-2kV4HpM/0/NgDn5PR9nB4XMzRQRKNJxCx8VNFtvQRzSjMv6BJC8/D/_DSC6392-D.jpg",
            "ArchivedSize": 3397642,
            "ArchivedMD5": "9f15561b4132197fa366d8de3313ca8c",
            "Status": "Open",
            "SubStatus": "NFS",
            "CanShare": false,
            "Comments": false,
            "ShowKeywords": true,
            "FormattedValues": {
                "Caption": {
                    "html": "Your photos on SmugMug will look great on any device. Just open your phone and navigate to the address sent to you in your welcome email. Also download the \"SmugMug\" iOS or Android app for even better viewing and managing your photos.<br />\n<br />\n(Photo by Aaron Meyers)",
                    "text": "Your photos on SmugMug will look great on any device. Just open your phone and navigate to the address sent to you in your welcome email. Also download the \"SmugMug\" iOS or Android app for even better viewing and managing your photos.\n\n(Photo by Aaron Meyers)"
                },
                "FileName": {
                    "html": "_DSC6392.jpg",
                    "text": "_DSC6392.jpg"
                }
            },
            "PreferredDisplayFileExtension": "JPG",
            "Uri": "/api/v2/image/2kV4HpM-0",
            "UriDescription": "Image by key",
            "Uris": {
                "LargestImage": {
                    "Uri": "/api/v2/image/2kV4HpM-0!largestimage",
                    "Locator": "LargestImage",
                    "LocatorType": "Object",
                    "UriDescription": "Largest size available for image",
                    "EndpointType": "LargestImage"
                },
                "ImageSizes": {
                    "Uri": "/api/v2/image/2kV4HpM-0!sizes",
                    "Locator": "ImageSizes",
                    "LocatorType": "Object",
                    "UriDescription": "Sizes available for image",
                    "EndpointType": "ImageSizes"
                },
                "ImageSizeDetails": {
                    "Uri": "/api/v2/image/2kV4HpM-0!sizedetails",
                    "Locator": "ImageSizeDetails",
                    "LocatorType": "Object",
                    "UriDescription": "Detailed size information for image",
                    "EndpointType": "ImageSizeDetails"
                },
                "PointOfInterest": {
                    "Uri": "/api/v2/image/2kV4HpM-0!pointofinterest",
                    "Locator": "PointOfInterest",
                    "LocatorType": "Object",
                    "UriDescription": "Point of interest for image",
                    "EndpointType": "PointOfInterest"
                },
                "PointOfInterestCrops": {
                    "Uri": "/api/v2/image/2kV4HpM-0!poicrops",
                    "Locator": "PointOfInterestCrops",
                    "LocatorType": "List",
                    "UriDescription": "PointOfInterest Crops for image",
                    "EndpointType": "PointOfInterestCrops"
                },
                "Regions": {
                    "Uri": "/api/v2/image/2kV4HpM-0!regions",
                    "Locator": "Region",
                    "LocatorType": "Objects",
                    "UriDescription": "Regions for image",
                    "EndpointType": "Regions"
                },
                "ImageMetadata": {
                    "Uri": "/api/v2/image/2kV4HpM-0!metadata",
                    "Locator": "ImageMetadata",
                    "LocatorType": "Object",
                    "UriDescription": "Metadata for image",
                    "EndpointType": "ImageMetadata"
                },
                "ImagePrices": {
                    "Uri": "/api/v2/image/2kV4HpM-0!prices",
                    "Locator": "CatalogSkuPrice",
                    "LocatorType": "Objects",
                    "UriDescription": "Purchasable Skus",
                    "EndpointType": "ImagePrices"
                },
                "ImagePricelistExclusions": {
                    "Uri": "/api/v2/image/2kV4HpM-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.05734,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}