Response [200 Ok]

Uri /api/v2/image/GHJz455-1
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/GHJz455-1

Uri /api/v2/image/GHJz455-1
UriDescription Image by key
Altitude 0
CanBuy true
CanEdit false
CanShare true
Caption 2011 Men's College Squash Association Team Championship Final: Trinity pre-match huddle This photo was published in the March 2011 issue of Squash Magazine (page 31).
Collectable false
Comments true
Date 2011-03-20T10:00:27+00:00
DateTimeOriginal 2011-02-27T20:05:28+00:00
DateTimeUploaded 2011-03-20T10:00:27+00:00
FileName 2011 Men Championships 537 2011-02-27.jpg
Format JPG
Hidden false
ImageKey GHJz455
IsArchive false
IsVideo false
KeywordArray
Array [7]
0 2011 Men's National Team Championships
1 College Squash
2 Trinity
3 Yale
4 Squash Magazine
5 Published
6 Portfolio
Keywords 2011 Men's National Team Championships; College Squash; Trinity; Yale; Squash Magazine; Published; Portfolio
LastUpdated 2016-01-04T17:59:33+00:00
Latitude 0.00000000000000
Longitude 0.00000000000000
OriginalHeight 2793
OriginalSize 4534945
OriginalWidth 1862
Processing false
Protected true
Serial 1
ShowKeywords true
ThumbnailUrl https://photos.smugmug.com/photos/i-GHJz455/1/Th/i-GHJz455-Th.jpg
Title empty string
UploadKey 1221928595
Watermark No
Watermarked true

Formatted Values

Caption [html, text]

html 2011 Men's College Squash Association Team Championship Final: Trinity pre-match huddle<br /> <br /> This photo was published in the March 2011 issue of Squash Magazine (page 31).
text 2011 Men's College Squash Association Team Championship Final: Trinity pre-match huddle This photo was published in the March 2011 issue of Squash Magazine (page 31).

FileName [html, text]

html 2011 Men Championships 537 2011-02-27.jpg
text 2011 Men Championships 537 2011-02-27.jpg

Uris

ImageComments
/api/v2/image/GHJz455!comments

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

ImageMetadata
/api/v2/image/GHJz455!metadata

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

ImagePricelistExclusions
/api/v2/image/GHJz455!pricelistexclusions

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

ImagePrices
/api/v2/image/GHJz455!prices

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

ImageSizeDetails
/api/v2/image/GHJz455-1!sizedetails

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

ImageSizes
/api/v2/image/GHJz455-1!sizes

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

LargestImage
/api/v2/image/GHJz455-1!largestimage

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

PointOfInterest
/api/v2/image/GHJz455!pointofinterest

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

PointOfInterestCrops
/api/v2/image/GHJz455!poicrops

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

Regions
/api/v2/image/GHJz455!regions

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

Timing

Total

cycles 1
objects 0
time 0.06502

Request

Uri /api/v2/image/GHJz455-1
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
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
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/GHJz455-1"
    },
    "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": "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": "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": "GHJz455-1"
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/image/GHJz455-1",
        "Locator": "Image",
        "LocatorType": "Object",
        "Image": {
            "Title": "",
            "Caption": "2011 Men's College Squash Association Team Championship Final: Trinity pre-match huddle\n\nThis photo was published in the March 2011 issue of Squash Magazine (page 31).",
            "Keywords": "2011 Men's National Team Championships; College Squash; Trinity; Yale; Squash Magazine; Published; Portfolio",
            "KeywordArray": [
                "2011 Men's National Team Championships",
                "College Squash",
                "Trinity",
                "Yale",
                "Squash Magazine",
                "Published",
                "Portfolio"
            ],
            "Watermark": "No",
            "Latitude": "0.00000000000000",
            "Longitude": "0.00000000000000",
            "Altitude": 0,
            "Hidden": false,
            "ThumbnailUrl": "https://photos.smugmug.com/photos/i-GHJz455/1/Th/i-GHJz455-Th.jpg",
            "FileName": "2011 Men Championships 537 2011-02-27.jpg",
            "Processing": false,
            "UploadKey": "1221928595",
            "Date": "2011-03-20T10:00:27+00:00",
            "DateTimeUploaded": "2011-03-20T10:00:27+00:00",
            "DateTimeOriginal": "2011-02-27T20:05:28+00:00",
            "Format": "JPG",
            "OriginalHeight": 2793,
            "OriginalWidth": 1862,
            "OriginalSize": 4534945,
            "LastUpdated": "2016-01-04T17:59:33+00:00",
            "Collectable": false,
            "IsArchive": false,
            "IsVideo": false,
            "CanEdit": false,
            "CanBuy": true,
            "Protected": true,
            "Watermarked": true,
            "ImageKey": "GHJz455",
            "Serial": 1,
            "CanShare": true,
            "Comments": true,
            "ShowKeywords": true,
            "FormattedValues": {
                "Caption": {
                    "html": "2011 Men's College Squash Association Team Championship Final: Trinity pre-match huddle<br />\n<br />\nThis photo was published in the March 2011 issue of Squash Magazine (page 31).",
                    "text": "2011 Men's College Squash Association Team Championship Final: Trinity pre-match huddle\n\nThis photo was published in the March 2011 issue of Squash Magazine (page 31)."
                },
                "FileName": {
                    "html": "2011 Men Championships 537 2011-02-27.jpg",
                    "text": "2011 Men Championships 537 2011-02-27.jpg"
                }
            },
            "Uri": "/api/v2/image/GHJz455-1",
            "UriDescription": "Image by key",
            "Uris": {
                "LargestImage": {
                    "Uri": "/api/v2/image/GHJz455-1!largestimage",
                    "Locator": "LargestImage",
                    "LocatorType": "Object",
                    "UriDescription": "Largest size available for image",
                    "EndpointType": "LargestImage"
                },
                "ImageSizes": {
                    "Uri": "/api/v2/image/GHJz455-1!sizes",
                    "Locator": "ImageSizes",
                    "LocatorType": "Object",
                    "UriDescription": "Sizes available for image",
                    "EndpointType": "ImageSizes"
                },
                "ImageSizeDetails": {
                    "Uri": "/api/v2/image/GHJz455-1!sizedetails",
                    "Locator": "ImageSizeDetails",
                    "LocatorType": "Object",
                    "UriDescription": "Detailed size information for image",
                    "EndpointType": "ImageSizeDetails"
                },
                "PointOfInterest": {
                    "Uri": "/api/v2/image/GHJz455!pointofinterest",
                    "Locator": "PointOfInterest",
                    "LocatorType": "Object",
                    "UriDescription": "Point of interest for image",
                    "EndpointType": "PointOfInterest"
                },
                "PointOfInterestCrops": {
                    "Uri": "/api/v2/image/GHJz455!poicrops",
                    "Locator": "PointOfInterestCrops",
                    "LocatorType": "List",
                    "UriDescription": "PointOfInterest Crops for image",
                    "EndpointType": "PointOfInterestCrops"
                },
                "Regions": {
                    "Uri": "/api/v2/image/GHJz455!regions",
                    "Locator": "Region",
                    "LocatorType": "Objects",
                    "UriDescription": "Regions for image",
                    "EndpointType": "Regions"
                },
                "ImageComments": {
                    "Uri": "/api/v2/image/GHJz455!comments",
                    "Locator": "Comment",
                    "LocatorType": "Objects",
                    "UriDescription": "Comments on image",
                    "EndpointType": "ImageComments"
                },
                "ImageMetadata": {
                    "Uri": "/api/v2/image/GHJz455!metadata",
                    "Locator": "ImageMetadata",
                    "LocatorType": "Object",
                    "UriDescription": "Metadata for image",
                    "EndpointType": "ImageMetadata"
                },
                "ImagePrices": {
                    "Uri": "/api/v2/image/GHJz455!prices",
                    "Locator": "CatalogSkuPrice",
                    "LocatorType": "Objects",
                    "UriDescription": "Purchasable Skus",
                    "EndpointType": "ImagePrices"
                },
                "ImagePricelistExclusions": {
                    "Uri": "/api/v2/image/GHJz455!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.06502,
                "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