Response [200 Ok]

Uri /api/v2/image/HvbZXJq-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/HvbZXJq-0

Uri /api/v2/image/HvbZXJq-0
UriDescription Image by key
Altitude 0
CanBuy true
CanEdit false
CanShare true
Caption This is the first year the blueberry bush in my yard has produced berries. Not too bad, considering I planted them two years ago.
Collectable true
Comments true
ComponentFileTypes
Array [0]
Date 2013-06-29T23:18:44+00:00
DateTimeOriginal 2013-06-29T21:29:34+00:00
DateTimeUploaded 2013-06-29T23:18:44+00:00
EZProject false
FileName DSCN9775hdr.jpg
Format JPG
Hidden false
ImageKey HvbZXJq
IsArchive false
IsVideo false
KeywordArray
Array [3]
0 Blueberries
1 plant
2 berries
Keywords Blueberries; plant; berries
LastUpdated 2014-12-23T02:15:39+00:00
Latitude 0
Longitude 0
OriginalHeight 3457
OriginalSize 7272332
OriginalWidth 2595
PreferredDisplayFileExtension JPG
Processing false
Protected false
Serial 0
ShowKeywords true
Status Open
SubStatus NFS
ThumbnailUrl https://photos.smugmug.com/Nature/Flowers/i-HvbZXJq/0/MXqh3nHjG8XKNsbfQ2th36VLJmmmBMhzffXwf5gv5/Th/DSCN9775hdr-Th.jpg
Title empty string
UploadKey 2605023320
Watermark No

Formatted Values

Caption [html, text]

html This is the first year the blueberry bush in my yard has produced berries. Not too bad, considering I planted them two years ago.
text This is the first year the blueberry bush in my yard has produced berries. Not too bad, considering I planted them two years ago.

FileName [html, text]

html DSCN9775hdr.jpg
text DSCN9775hdr.jpg

Uris

ImageComments
/api/v2/image/HvbZXJq-0!comments

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

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

Uri /api/v2/image/HvbZXJq-0!pricelistexclusions
UriDescription Pricelist information for an image
EndpointType ImagePricelistExclusions
Locator ImagePricelistExclusions
LocatorType Object
ImagePricelistExclusions [1 of 1]

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

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

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

Uri /api/v2/image/HvbZXJq-0!sizedetails
UriDescription Detailed size information for image
EndpointType ImageSizeDetails
Locator ImageSizeDetails
LocatorType Object
ImageSizeDetails [1 of 1]

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

Uri /api/v2/image/HvbZXJq-0!sizes
UriDescription Sizes available for image
EndpointType ImageSizes
Locator ImageSizes
LocatorType Object
ImageSizes [1 of 1]

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

Uri /api/v2/image/HvbZXJq-0!largestimage
UriDescription Largest size available for image
EndpointType LargestImage
Locator LargestImage
LocatorType Object
LargestImage [1 of 1]

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

Uri /api/v2/image/HvbZXJq-0!pointofinterest
UriDescription Point of interest for image
EndpointType PointOfInterest
Locator PointOfInterest
LocatorType Object
PointOfInterest [1 of 1]

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

Uri /api/v2/image/HvbZXJq-0!poicrops
UriDescription PointOfInterest Crops for image
EndpointType PointOfInterestCrops
Locator PointOfInterestCrops
LocatorType List
PointOfInterestCrops [1 of 1]

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

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

Timing

Total

cycles 1
objects 0
time 0.08306

Request

Uri /api/v2/image/HvbZXJq-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
  • "ArchivedSize" and "ArchivedMD5" refer to the untouched version of the photo originally uploaded
  • "ArchivedUri" will generate a download link for the image based on its source album download settings and owner permissions

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/HvbZXJq-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",
            "\"ArchivedSize\" and \"ArchivedMD5\" refer to the untouched version of the photo originally uploaded",
            "\"ArchivedUri\" will generate a download link for the image based on its source album download settings and owner permissions"
        ],
        "Path": [
            {
                "type": "path",
                "text": "api"
            },
            {
                "type": "path",
                "text": "v2"
            },
            {
                "type": "path",
                "text": "image"
            },
            {
                "type": "singleparam",
                "param_name": "imagekey",
                "param_value": "HvbZXJq-0",
                "param_validator": {}
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/image/HvbZXJq-0",
        "Locator": "Image",
        "LocatorType": "Object",
        "Image": {
            "Title": "",
            "Caption": "This is the first year the blueberry bush in my yard has produced berries. Not too bad, considering I planted them two years ago.",
            "Keywords": "Blueberries; plant; berries",
            "KeywordArray": [
                "Blueberries",
                "plant",
                "berries"
            ],
            "Watermark": "No",
            "Latitude": "0",
            "Longitude": "0",
            "Altitude": 0,
            "Hidden": false,
            "ThumbnailUrl": "https://photos.smugmug.com/Nature/Flowers/i-HvbZXJq/0/MXqh3nHjG8XKNsbfQ2th36VLJmmmBMhzffXwf5gv5/Th/DSCN9775hdr-Th.jpg",
            "FileName": "DSCN9775hdr.jpg",
            "Processing": false,
            "UploadKey": "2605023320",
            "Date": "2013-06-29T23:18:44+00:00",
            "DateTimeUploaded": "2013-06-29T23:18:44+00:00",
            "DateTimeOriginal": "2013-06-29T21:29:34+00:00",
            "Format": "JPG",
            "OriginalHeight": 3457,
            "OriginalWidth": 2595,
            "OriginalSize": 7272332,
            "LastUpdated": "2014-12-23T02:15:39+00:00",
            "Collectable": true,
            "IsArchive": false,
            "IsVideo": false,
            "ComponentFileTypes": [],
            "CanEdit": false,
            "CanBuy": true,
            "Protected": false,
            "EZProject": false,
            "ImageKey": "HvbZXJq",
            "Serial": 0,
            "Status": "Open",
            "SubStatus": "NFS",
            "CanShare": true,
            "Comments": true,
            "ShowKeywords": true,
            "FormattedValues": {
                "Caption": {
                    "html": "This is the first year the blueberry bush in my yard has produced berries. Not too bad, considering I planted them two years ago.",
                    "text": "This is the first year the blueberry bush in my yard has produced berries. Not too bad, considering I planted them two years ago."
                },
                "FileName": {
                    "html": "DSCN9775hdr.jpg",
                    "text": "DSCN9775hdr.jpg"
                }
            },
            "PreferredDisplayFileExtension": "JPG",
            "Uri": "/api/v2/image/HvbZXJq-0",
            "UriDescription": "Image by key",
            "Uris": {
                "LargestImage": {
                    "Uri": "/api/v2/image/HvbZXJq-0!largestimage",
                    "Locator": "LargestImage",
                    "LocatorType": "Object",
                    "UriDescription": "Largest size available for image",
                    "EndpointType": "LargestImage"
                },
                "ImageSizes": {
                    "Uri": "/api/v2/image/HvbZXJq-0!sizes",
                    "Locator": "ImageSizes",
                    "LocatorType": "Object",
                    "UriDescription": "Sizes available for image",
                    "EndpointType": "ImageSizes"
                },
                "ImageSizeDetails": {
                    "Uri": "/api/v2/image/HvbZXJq-0!sizedetails",
                    "Locator": "ImageSizeDetails",
                    "LocatorType": "Object",
                    "UriDescription": "Detailed size information for image",
                    "EndpointType": "ImageSizeDetails"
                },
                "PointOfInterest": {
                    "Uri": "/api/v2/image/HvbZXJq-0!pointofinterest",
                    "Locator": "PointOfInterest",
                    "LocatorType": "Object",
                    "UriDescription": "Point of interest for image",
                    "EndpointType": "PointOfInterest"
                },
                "PointOfInterestCrops": {
                    "Uri": "/api/v2/image/HvbZXJq-0!poicrops",
                    "Locator": "PointOfInterestCrops",
                    "LocatorType": "List",
                    "UriDescription": "PointOfInterest Crops for image",
                    "EndpointType": "PointOfInterestCrops"
                },
                "Regions": {
                    "Uri": "/api/v2/image/HvbZXJq-0!regions",
                    "Locator": "Region",
                    "LocatorType": "Objects",
                    "UriDescription": "Regions for image",
                    "EndpointType": "Regions"
                },
                "ImageComments": {
                    "Uri": "/api/v2/image/HvbZXJq-0!comments",
                    "Locator": "Comment",
                    "LocatorType": "Objects",
                    "UriDescription": "Comments on image",
                    "EndpointType": "ImageComments"
                },
                "ImagePrices": {
                    "Uri": "/api/v2/image/HvbZXJq-0!prices",
                    "Locator": "CatalogSkuPrice",
                    "LocatorType": "Objects",
                    "UriDescription": "Purchasable Skus",
                    "EndpointType": "ImagePrices"
                },
                "ImagePricelistExclusions": {
                    "Uri": "/api/v2/image/HvbZXJq-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.08306,
                "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