Response [200 Ok]
| Uri | /api/v2/image/K9hTjQt-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]
- Sand Hogs Laboring Under High Air Pressure
/api/v2/image/K9hTjQt-1
| Uri | /api/v2/image/K9hTjQt-1 | ||||||
|---|---|---|---|---|---|---|---|
| UriDescription | Image by key | ||||||
| Altitude | 0 | ||||||
| ArchivedMD5 | f23e3b1ed20f4fd80c6bdd030620bec2 | ||||||
| ArchivedSize | 2004908 | ||||||
| ArchivedUri | https://photos.smugmug.com/Postcards/19TransNYFD/i-K9hTjQt/1/L3VfSCS97NCGGBD386RJCV38vrjtvRMCL5DJ2gRZB/D/BS-SU-00117zm-D.jpg | ||||||
| CanBuy | true | ||||||
| CanEdit | false | ||||||
| CanShare | true | ||||||
| Caption | From the McAdoo System Pamphlet ``And wherein labor under high air pressure, an army of sand hogs´´ | ||||||
| Collectable | false | ||||||
| Comments | true | ||||||
| ComponentFileTypes | |||||||
| Date | 2015-02-11T17:49:02+00:00 | ||||||
| DateTimeUploaded | 2015-02-11T17:49:02+00:00 | ||||||
| EZProject | false | ||||||
| FileName | BS-SU-00117zm.jpg | ||||||
| Format | JPG | ||||||
| Hidden | false | ||||||
| ImageKey | K9hTjQt | ||||||
| IsArchive | false | ||||||
| IsVideo | false | ||||||
| KeywordArray |
Array [3]
|
||||||
| Keywords | 00117zm; Manhattan; subways | ||||||
| LastUpdated | 2017-10-10T20:00:10+00:00 | ||||||
| Latitude | 0 | ||||||
| Longitude | 0 | ||||||
| OriginalHeight | 1776 | ||||||
| OriginalSize | 2004908 | ||||||
| OriginalWidth | 3000 | ||||||
| PreferredDisplayFileExtension | JPG | ||||||
| Processing | false | ||||||
| Protected | false | ||||||
| Serial | 1 | ||||||
| ShowKeywords | true | ||||||
| Status | Open | ||||||
| SubStatus | NFS | ||||||
| ThumbnailUrl | https://photos.smugmug.com/Postcards/19TransNYFD/i-K9hTjQt/1/L7c348wGmpVSJ3XRFK9N939qTVR2nKCGp6HtDBZbh/Th/BS-SU-00117zm-Th.jpg | ||||||
| Title | Sand Hogs Laboring Under High Air Pressure | ||||||
| UploadKey | 3872674576 | ||||||
| Watermark | No | ||||||
| Watermarked | true |
Formatted Values
Caption [html, text]
| html | From the McAdoo System Pamphlet<br /> ``And wherein labor under high air pressure, an army of sand hogs´´ |
|---|---|
| text | From the McAdoo System Pamphlet ``And wherein labor under high air pressure, an army of sand hogs´´ |
FileName [html, text]
| html | BS-SU-00117zm.jpg |
|---|---|
| text | BS-SU-00117zm.jpg |
Uris
ImageComments
/api/v2/image/K9hTjQt-1!comments
| Uri | /api/v2/image/K9hTjQt-1!comments |
|---|---|
| UriDescription | Comments on image |
| EndpointType | ImageComments |
| Locator | Comment |
| LocatorType | Objects |
ImageMetadata
/api/v2/image/K9hTjQt-1!metadata
| Uri | /api/v2/image/K9hTjQt-1!metadata |
|---|---|
| UriDescription | Metadata for image |
| EndpointType | ImageMetadata |
| Locator | ImageMetadata |
| LocatorType | Object |
ImagePricelistExclusions
/api/v2/image/K9hTjQt-1!pricelistexclusions
| Uri | /api/v2/image/K9hTjQt-1!pricelistexclusions |
|---|---|
| UriDescription | Pricelist information for an image |
| EndpointType | ImagePricelistExclusions |
| Locator | ImagePricelistExclusions |
| LocatorType | Object |
ImagePrices
/api/v2/image/K9hTjQt-1!prices
| Uri | /api/v2/image/K9hTjQt-1!prices |
|---|---|
| UriDescription | Purchasable Skus |
| EndpointType | ImagePrices |
| Locator | CatalogSkuPrice |
| LocatorType | Objects |
ImageSizeDetails
/api/v2/image/K9hTjQt-1!sizedetails
| Uri | /api/v2/image/K9hTjQt-1!sizedetails |
|---|---|
| UriDescription | Detailed size information for image |
| EndpointType | ImageSizeDetails |
| Locator | ImageSizeDetails |
| LocatorType | Object |
ImageSizes
/api/v2/image/K9hTjQt-1!sizes
| Uri | /api/v2/image/K9hTjQt-1!sizes |
|---|---|
| UriDescription | Sizes available for image |
| EndpointType | ImageSizes |
| Locator | ImageSizes |
| LocatorType | Object |
LargestImage
/api/v2/image/K9hTjQt-1!largestimage
| Uri | /api/v2/image/K9hTjQt-1!largestimage |
|---|---|
| UriDescription | Largest size available for image |
| EndpointType | LargestImage |
| Locator | LargestImage |
| LocatorType | Object |
PointOfInterest
/api/v2/image/K9hTjQt-1!pointofinterest
| Uri | /api/v2/image/K9hTjQt-1!pointofinterest |
|---|---|
| UriDescription | Point of interest for image |
| EndpointType | PointOfInterest |
| Locator | PointOfInterest |
| LocatorType | Object |
PointOfInterestCrops
/api/v2/image/K9hTjQt-1!poicrops
| Uri | /api/v2/image/K9hTjQt-1!poicrops |
|---|---|
| UriDescription | PointOfInterest Crops for image |
| EndpointType | PointOfInterestCrops |
| Locator | PointOfInterestCrops |
| LocatorType | List |
Regions
/api/v2/image/K9hTjQt-1!regions
| Uri | /api/v2/image/K9hTjQt-1!regions |
|---|---|
| UriDescription | Regions for image |
| EndpointType | Regions |
| Locator | Region |
| LocatorType | Objects |
Request
| Uri | /api/v2/image/K9hTjQt-1 |
|---|---|
| Method | GET |
| Version | v2 |
Config
{
"expand_method": "ref",
"shorturis": false
}
Options
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 |
|
|---|
GET
| Permissions |
|
|---|
PATCH
| Permissions |
|
|---|
DELETE
| Permissions |
|
|---|
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/K9hTjQt-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",
"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": "K9hTjQt-1",
"param_validator": {}
}
]
},
"Response": {
"Uri": "/api/v2/image/K9hTjQt-1",
"Locator": "Image",
"LocatorType": "Object",
"Image": {
"Title": "Sand Hogs Laboring Under High Air Pressure",
"Caption": "From the McAdoo System Pamphlet\n``And wherein labor under high air pressure, an army of sand hogs\u00b4\u00b4",
"Keywords": "00117zm; Manhattan; subways",
"KeywordArray": [
"00117zm",
"Manhattan",
"subways"
],
"Watermark": "No",
"Latitude": "0",
"Longitude": "0",
"Altitude": 0,
"Hidden": false,
"ThumbnailUrl": "https://photos.smugmug.com/Postcards/19TransNYFD/i-K9hTjQt/1/L7c348wGmpVSJ3XRFK9N939qTVR2nKCGp6HtDBZbh/Th/BS-SU-00117zm-Th.jpg",
"FileName": "BS-SU-00117zm.jpg",
"Processing": false,
"UploadKey": "3872674576",
"Date": "2015-02-11T17:49:02+00:00",
"DateTimeUploaded": "2015-02-11T17:49:02+00:00",
"Format": "JPG",
"OriginalHeight": 1776,
"OriginalWidth": 3000,
"OriginalSize": 2004908,
"LastUpdated": "2017-10-10T20:00:10+00:00",
"Collectable": false,
"IsArchive": false,
"IsVideo": false,
"ComponentFileTypes": [],
"CanEdit": false,
"CanBuy": true,
"Protected": false,
"EZProject": false,
"Watermarked": true,
"ImageKey": "K9hTjQt",
"Serial": 1,
"ArchivedUri": "https://photos.smugmug.com/Postcards/19TransNYFD/i-K9hTjQt/1/L3VfSCS97NCGGBD386RJCV38vrjtvRMCL5DJ2gRZB/D/BS-SU-00117zm-D.jpg",
"ArchivedSize": 2004908,
"ArchivedMD5": "f23e3b1ed20f4fd80c6bdd030620bec2",
"Status": "Open",
"SubStatus": "NFS",
"CanShare": true,
"Comments": true,
"ShowKeywords": true,
"FormattedValues": {
"Caption": {
"html": "From the McAdoo System Pamphlet<br />\n``And wherein labor under high air pressure, an army of sand hogs\u00b4\u00b4",
"text": "From the McAdoo System Pamphlet\n``And wherein labor under high air pressure, an army of sand hogs\u00b4\u00b4"
},
"FileName": {
"html": "BS-SU-00117zm.jpg",
"text": "BS-SU-00117zm.jpg"
}
},
"PreferredDisplayFileExtension": "JPG",
"Uri": "/api/v2/image/K9hTjQt-1",
"UriDescription": "Image by key",
"Uris": {
"LargestImage": {
"Uri": "/api/v2/image/K9hTjQt-1!largestimage",
"Locator": "LargestImage",
"LocatorType": "Object",
"UriDescription": "Largest size available for image",
"EndpointType": "LargestImage"
},
"ImageSizes": {
"Uri": "/api/v2/image/K9hTjQt-1!sizes",
"Locator": "ImageSizes",
"LocatorType": "Object",
"UriDescription": "Sizes available for image",
"EndpointType": "ImageSizes"
},
"ImageSizeDetails": {
"Uri": "/api/v2/image/K9hTjQt-1!sizedetails",
"Locator": "ImageSizeDetails",
"LocatorType": "Object",
"UriDescription": "Detailed size information for image",
"EndpointType": "ImageSizeDetails"
},
"PointOfInterest": {
"Uri": "/api/v2/image/K9hTjQt-1!pointofinterest",
"Locator": "PointOfInterest",
"LocatorType": "Object",
"UriDescription": "Point of interest for image",
"EndpointType": "PointOfInterest"
},
"PointOfInterestCrops": {
"Uri": "/api/v2/image/K9hTjQt-1!poicrops",
"Locator": "PointOfInterestCrops",
"LocatorType": "List",
"UriDescription": "PointOfInterest Crops for image",
"EndpointType": "PointOfInterestCrops"
},
"Regions": {
"Uri": "/api/v2/image/K9hTjQt-1!regions",
"Locator": "Region",
"LocatorType": "Objects",
"UriDescription": "Regions for image",
"EndpointType": "Regions"
},
"ImageComments": {
"Uri": "/api/v2/image/K9hTjQt-1!comments",
"Locator": "Comment",
"LocatorType": "Objects",
"UriDescription": "Comments on image",
"EndpointType": "ImageComments"
},
"ImageMetadata": {
"Uri": "/api/v2/image/K9hTjQt-1!metadata",
"Locator": "ImageMetadata",
"LocatorType": "Object",
"UriDescription": "Metadata for image",
"EndpointType": "ImageMetadata"
},
"ImagePrices": {
"Uri": "/api/v2/image/K9hTjQt-1!prices",
"Locator": "CatalogSkuPrice",
"LocatorType": "Objects",
"UriDescription": "Purchasable Skus",
"EndpointType": "ImagePrices"
},
"ImagePricelistExclusions": {
"Uri": "/api/v2/image/K9hTjQt-1!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.05936,
"cycles": 1,
"objects": 0
}
}
},
"Code": 200,
"Message": "Ok"
}