Response [200 Ok]

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

Uri /api/v2/image/3kP98SK-1
UriDescription Image by key
Altitude 18
CanBuy false
CanEdit false
CanShare true
Caption Sunrise over Ross Witham Beach
Collectable false
Comments false
Date 2015-03-24T02:03:50+00:00
FileName FL_13842-13844_HDR_ID.jpg
Format JPG
Hidden false
ImageKey 3kP98SK
IsArchive false
IsVideo false
KeywordArray
Array [18]
0 13842
1 13844
2 HDR
3 Florida
4 nature
5 sunrise
6 beach
7 water
8 glow
9 clouds
10 sand
11 rocks
12 sky
13 waves
14 high tide
15 spray
16 wind
17 magic
Keywords 13842; 13844; HDR; Florida; nature; sunrise; beach; water; glow; clouds; sand; rocks; sky; waves; high tide; spray; wind; magic
LastUpdated 2015-03-24T05:16:56+00:00
Latitude 27.20015833333300
Longitude -80.16555000000000
OriginalHeight 3394
OriginalSize 10683737
OriginalWidth 5096
Processing false
Protected false
ShowKeywords true
ThumbnailUrl https://photos.smugmug.com/photos/i-3kP98SK/1/Th/i-3kP98SK-Th.jpg
Title empty string
UploadKey 3949175373
Watermark No
Watermarked false

Formatted Values

Caption [html, text]

html Sunrise over Ross Witham Beach
text Sunrise over Ross Witham Beach

FileName [html, text]

html FL_13842-13844_HDR_ID.jpg
text FL_13842-13844_HDR_ID.jpg

Uris

ImageMetadata
/api/v2/image/3kP98SK!metadata

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

ImagePricelistExclusions
/api/v2/image/3kP98SK!pricelistexclusions

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

ImagePrices
/api/v2/image/3kP98SK!prices

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

ImageSizeDetails
/api/v2/image/3kP98SK-1!sizedetails

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

ImageSizes
/api/v2/image/3kP98SK-1!sizes

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

LargestImage
/api/v2/image/3kP98SK-1!largestimage

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

PointOfInterest
/api/v2/image/3kP98SK!pointofinterest

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

PointOfInterestCrops
/api/v2/image/3kP98SK!poicrops

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

Regions
/api/v2/image/3kP98SK!regions

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

Timing

Total

cycles 1
objects 0
time 0.0374

Request

Uri /api/v2/image/3kP98SK-1
Method GET
Version v2

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 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
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/3kP98SK-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",
                "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": "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": "3kP98SK-1"
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/image/3kP98SK-1",
        "Locator": "Image",
        "LocatorType": "Object",
        "Image": {
            "Title": "",
            "Caption": "Sunrise over Ross Witham Beach",
            "Keywords": "13842; 13844; HDR; Florida; nature; sunrise; beach; water; glow; clouds; sand; rocks; sky; waves; high tide; spray; wind; magic",
            "KeywordArray": [
                "13842",
                "13844",
                "HDR",
                "Florida",
                "nature",
                "sunrise",
                "beach",
                "water",
                "glow",
                "clouds",
                "sand",
                "rocks",
                "sky",
                "waves",
                "high tide",
                "spray",
                "wind",
                "magic"
            ],
            "Watermark": "No",
            "Latitude": "27.20015833333300",
            "Longitude": "-80.16555000000000",
            "Altitude": 18,
            "Hidden": false,
            "ThumbnailUrl": "https://photos.smugmug.com/photos/i-3kP98SK/1/Th/i-3kP98SK-Th.jpg",
            "FileName": "FL_13842-13844_HDR_ID.jpg",
            "Processing": false,
            "UploadKey": "3949175373",
            "Date": "2015-03-24T02:03:50+00:00",
            "Format": "JPG",
            "OriginalHeight": 3394,
            "OriginalWidth": 5096,
            "OriginalSize": 10683737,
            "LastUpdated": "2015-03-24T05:16:56+00:00",
            "Collectable": false,
            "IsArchive": false,
            "IsVideo": false,
            "CanEdit": false,
            "CanBuy": false,
            "Protected": false,
            "Watermarked": false,
            "ImageKey": "3kP98SK",
            "CanShare": true,
            "Comments": false,
            "ShowKeywords": true,
            "FormattedValues": {
                "Caption": {
                    "html": "Sunrise over Ross Witham Beach",
                    "text": "Sunrise over Ross Witham Beach"
                },
                "FileName": {
                    "html": "FL_13842-13844_HDR_ID.jpg",
                    "text": "FL_13842-13844_HDR_ID.jpg"
                }
            },
            "Uri": "/api/v2/image/3kP98SK-1",
            "UriDescription": "Image by key",
            "Uris": {
                "LargestImage": {
                    "Uri": "/api/v2/image/3kP98SK-1!largestimage",
                    "Locator": "LargestImage",
                    "LocatorType": "Object",
                    "UriDescription": "Largest size available for image",
                    "EndpointType": "LargestImage"
                },
                "ImageSizes": {
                    "Uri": "/api/v2/image/3kP98SK-1!sizes",
                    "Locator": "ImageSizes",
                    "LocatorType": "Object",
                    "UriDescription": "Sizes available for image",
                    "EndpointType": "ImageSizes"
                },
                "ImageSizeDetails": {
                    "Uri": "/api/v2/image/3kP98SK-1!sizedetails",
                    "Locator": "ImageSizeDetails",
                    "LocatorType": "Object",
                    "UriDescription": "Detailed size information for image",
                    "EndpointType": "ImageSizeDetails"
                },
                "PointOfInterest": {
                    "Uri": "/api/v2/image/3kP98SK!pointofinterest",
                    "Locator": "PointOfInterest",
                    "LocatorType": "Object",
                    "UriDescription": "Point of interest for image",
                    "EndpointType": "PointOfInterest"
                },
                "PointOfInterestCrops": {
                    "Uri": "/api/v2/image/3kP98SK!poicrops",
                    "Locator": "PointOfInterestCrops",
                    "LocatorType": "List",
                    "UriDescription": "PointOfInterest Crops for image",
                    "EndpointType": "PointOfInterestCrops"
                },
                "Regions": {
                    "Uri": "/api/v2/image/3kP98SK!regions",
                    "Locator": "Region",
                    "LocatorType": "Objects",
                    "UriDescription": "Regions for image",
                    "EndpointType": "Regions"
                },
                "ImageMetadata": {
                    "Uri": "/api/v2/image/3kP98SK!metadata",
                    "Locator": "ImageMetadata",
                    "LocatorType": "Object",
                    "UriDescription": "Metadata for image",
                    "EndpointType": "ImageMetadata"
                },
                "ImagePrices": {
                    "Uri": "/api/v2/image/3kP98SK!prices",
                    "Locator": "CatalogSkuPrice",
                    "LocatorType": "Objects",
                    "UriDescription": "Purchasable Skus",
                    "EndpointType": "ImagePrices"
                },
                "ImagePricelistExclusions": {
                    "Uri": "/api/v2/image/3kP98SK!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.0374,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}

Contents

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