Response [200 Ok]
| Uri | /api/v2/image/sxDkbVM-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]
- Edit the Title and Caption of this photo
/api/v2/image/sxDkbVM-0
| Uri | /api/v2/image/sxDkbVM-0 | ||||||
|---|---|---|---|---|---|---|---|
| UriDescription | Image by key | ||||||
| Altitude | 0 | ||||||
| ArchivedMD5 | d3bbebeda503b1928fbc9b4257fb902a | ||||||
| ArchivedSize | 3055240 | ||||||
| ArchivedUri | https://photos.smugmug.com/Sample-Photos-for-Trials/Sample-Photos/i-sxDkbVM/0/NPk2T2N6jGGFMW779FLgL84DzF84NqffTJpgmBzM8/D/_DSC9536-1-D.jpg | ||||||
| CanBuy | false | ||||||
| CanEdit | false | ||||||
| CanShare | false | ||||||
| Caption | Titles, Caption and Keywords can be set on each photo. If you've used a photo editor to tag your photos, those will be sucked up and used on SmugMug. But you can always add or edit them on SmugMug too. Just click on this photo to open it large, click on the "Photo Details", and then seelct "Edit Photo Details". You can also press the "E" key (for "Edit" to jump right into it). (Photo by Chris MacAskill) | ||||||
| Collectable | true | ||||||
| Comments | false | ||||||
| ComponentFileTypes | |||||||
| Date | 2020-04-21T05:57:35+00:00 | ||||||
| DateTimeOriginal | 2015-07-01T22:47:38+00:00 | ||||||
| DateTimeUploaded | 2020-04-21T05:57:35+00:00 | ||||||
| EZProject | false | ||||||
| FileName | _DSC9536-1.jpg | ||||||
| Format | JPG | ||||||
| Hidden | false | ||||||
| ImageKey | sxDkbVM | ||||||
| IsArchive | false | ||||||
| IsVideo | false | ||||||
| KeywordArray |
Array [3]
|
||||||
| Keywords | Ivan Makarov; onboardingsamplephoto; samplephoto | ||||||
| LastUpdated | 2020-04-21T05:57:37+00:00 | ||||||
| Latitude | 0 | ||||||
| Longitude | 0 | ||||||
| OriginalHeight | 3417 | ||||||
| OriginalSize | 3055240 | ||||||
| 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-sxDkbVM/0/KDRCChXfF3vwJMDTMM8wPJwhx27rKK9g5KxGV7gRP/Th/_DSC9536-1-Th.jpg | ||||||
| Title | Edit the Title and Caption of this photo | ||||||
| UploadKey | 9415440969 | ||||||
| Watermark | No | ||||||
| Watermarked | false |
Formatted Values
Caption [html, text]
| html | Titles, Caption and Keywords can be set on each photo. If you've used a photo editor to tag your photos, those will be sucked up and used on SmugMug. But you can always add or edit them on SmugMug too. Just click on this photo to open it large, click on the "Photo Details", and then seelct "Edit Photo Details". You can also press the "E" key (for "Edit" to jump right into it).<br /> <br /> (Photo by Chris MacAskill) |
|---|---|
| text | Titles, Caption and Keywords can be set on each photo. If you've used a photo editor to tag your photos, those will be sucked up and used on SmugMug. But you can always add or edit them on SmugMug too. Just click on this photo to open it large, click on the "Photo Details", and then seelct "Edit Photo Details". You can also press the "E" key (for "Edit" to jump right into it). (Photo by Chris MacAskill) |
FileName [html, text]
| html | _DSC9536-1.jpg |
|---|---|
| text | _DSC9536-1.jpg |
Uris
ImageMetadata
/api/v2/image/sxDkbVM-0!metadata
| Uri | /api/v2/image/sxDkbVM-0!metadata |
|---|---|
| UriDescription | Metadata for image |
| EndpointType | ImageMetadata |
| Locator | ImageMetadata |
| LocatorType | Object |
ImagePricelistExclusions
/api/v2/image/sxDkbVM-0!pricelistexclusions
| Uri | /api/v2/image/sxDkbVM-0!pricelistexclusions |
|---|---|
| UriDescription | Pricelist information for an image |
| EndpointType | ImagePricelistExclusions |
| Locator | ImagePricelistExclusions |
| LocatorType | Object |
ImagePrices
/api/v2/image/sxDkbVM-0!prices
| Uri | /api/v2/image/sxDkbVM-0!prices |
|---|---|
| UriDescription | Purchasable Skus |
| EndpointType | ImagePrices |
| Locator | CatalogSkuPrice |
| LocatorType | Objects |
ImageSizeDetails
/api/v2/image/sxDkbVM-0!sizedetails
| Uri | /api/v2/image/sxDkbVM-0!sizedetails |
|---|---|
| UriDescription | Detailed size information for image |
| EndpointType | ImageSizeDetails |
| Locator | ImageSizeDetails |
| LocatorType | Object |
ImageSizes
/api/v2/image/sxDkbVM-0!sizes
| Uri | /api/v2/image/sxDkbVM-0!sizes |
|---|---|
| UriDescription | Sizes available for image |
| EndpointType | ImageSizes |
| Locator | ImageSizes |
| LocatorType | Object |
LargestImage
/api/v2/image/sxDkbVM-0!largestimage
| Uri | /api/v2/image/sxDkbVM-0!largestimage |
|---|---|
| UriDescription | Largest size available for image |
| EndpointType | LargestImage |
| Locator | LargestImage |
| LocatorType | Object |
PointOfInterest
/api/v2/image/sxDkbVM-0!pointofinterest
| Uri | /api/v2/image/sxDkbVM-0!pointofinterest |
|---|---|
| UriDescription | Point of interest for image |
| EndpointType | PointOfInterest |
| Locator | PointOfInterest |
| LocatorType | Object |
PointOfInterestCrops
/api/v2/image/sxDkbVM-0!poicrops
| Uri | /api/v2/image/sxDkbVM-0!poicrops |
|---|---|
| UriDescription | PointOfInterest Crops for image |
| EndpointType | PointOfInterestCrops |
| Locator | PointOfInterestCrops |
| LocatorType | List |
Regions
/api/v2/image/sxDkbVM-0!regions
| Uri | /api/v2/image/sxDkbVM-0!regions |
|---|---|
| UriDescription | Regions for image |
| EndpointType | Regions |
| Locator | Region |
| LocatorType | Objects |
Request
| Uri | /api/v2/image/sxDkbVM-0 |
|---|---|
| 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
- "ArchivedUri", "ArchivedSize" and "ArchivedMD5" refer to the untouched version of the photo originally uploaded
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/sxDkbVM-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": "sxDkbVM-0",
"param_validator": {}
}
]
},
"Response": {
"Uri": "/api/v2/image/sxDkbVM-0",
"Locator": "Image",
"LocatorType": "Object",
"Image": {
"Title": "Edit the Title and Caption of this photo",
"Caption": "Titles, Caption and Keywords can be set on each photo. If you've used a photo editor to tag your photos, those will be sucked up and used on SmugMug. But you can always add or edit them on SmugMug too. Just click on this photo to open it large, click on the \"Photo Details\", and then seelct \"Edit Photo Details\". You can also press the \"E\" key (for \"Edit\" to jump right into it).\n\n(Photo by Chris MacAskill)",
"Keywords": "Ivan Makarov; onboardingsamplephoto; samplephoto",
"KeywordArray": [
"Ivan Makarov",
"onboardingsamplephoto",
"samplephoto"
],
"Watermark": "No",
"Latitude": "0",
"Longitude": "0",
"Altitude": 0,
"Hidden": false,
"ThumbnailUrl": "https://photos.smugmug.com/Sample-Photos-for-Trials/Sample-Photos/i-sxDkbVM/0/KDRCChXfF3vwJMDTMM8wPJwhx27rKK9g5KxGV7gRP/Th/_DSC9536-1-Th.jpg",
"FileName": "_DSC9536-1.jpg",
"Processing": false,
"UploadKey": "9415440969",
"Date": "2020-04-21T05:57:35+00:00",
"DateTimeUploaded": "2020-04-21T05:57:35+00:00",
"DateTimeOriginal": "2015-07-01T22:47:38+00:00",
"Format": "JPG",
"OriginalHeight": 3417,
"OriginalWidth": 5120,
"OriginalSize": 3055240,
"LastUpdated": "2020-04-21T05:57:37+00:00",
"Collectable": true,
"IsArchive": false,
"IsVideo": false,
"ComponentFileTypes": [],
"CanEdit": false,
"CanBuy": false,
"Protected": false,
"EZProject": false,
"Watermarked": false,
"ImageKey": "sxDkbVM",
"Serial": 0,
"ArchivedUri": "https://photos.smugmug.com/Sample-Photos-for-Trials/Sample-Photos/i-sxDkbVM/0/NPk2T2N6jGGFMW779FLgL84DzF84NqffTJpgmBzM8/D/_DSC9536-1-D.jpg",
"ArchivedSize": 3055240,
"ArchivedMD5": "d3bbebeda503b1928fbc9b4257fb902a",
"Status": "Open",
"SubStatus": "NFS",
"CanShare": false,
"Comments": false,
"ShowKeywords": true,
"FormattedValues": {
"Caption": {
"html": "Titles, Caption and Keywords can be set on each photo. If you've used a photo editor to tag your photos, those will be sucked up and used on SmugMug. But you can always add or edit them on SmugMug too. Just click on this photo to open it large, click on the \"Photo Details\", and then seelct \"Edit Photo Details\". You can also press the \"E\" key (for \"Edit\" to jump right into it).<br />\n<br />\n(Photo by Chris MacAskill)",
"text": "Titles, Caption and Keywords can be set on each photo. If you've used a photo editor to tag your photos, those will be sucked up and used on SmugMug. But you can always add or edit them on SmugMug too. Just click on this photo to open it large, click on the \"Photo Details\", and then seelct \"Edit Photo Details\". You can also press the \"E\" key (for \"Edit\" to jump right into it).\n\n(Photo by Chris MacAskill)"
},
"FileName": {
"html": "_DSC9536-1.jpg",
"text": "_DSC9536-1.jpg"
}
},
"PreferredDisplayFileExtension": "JPG",
"Uri": "/api/v2/image/sxDkbVM-0",
"UriDescription": "Image by key",
"Uris": {
"LargestImage": {
"Uri": "/api/v2/image/sxDkbVM-0!largestimage",
"Locator": "LargestImage",
"LocatorType": "Object",
"UriDescription": "Largest size available for image",
"EndpointType": "LargestImage"
},
"ImageSizes": {
"Uri": "/api/v2/image/sxDkbVM-0!sizes",
"Locator": "ImageSizes",
"LocatorType": "Object",
"UriDescription": "Sizes available for image",
"EndpointType": "ImageSizes"
},
"ImageSizeDetails": {
"Uri": "/api/v2/image/sxDkbVM-0!sizedetails",
"Locator": "ImageSizeDetails",
"LocatorType": "Object",
"UriDescription": "Detailed size information for image",
"EndpointType": "ImageSizeDetails"
},
"PointOfInterest": {
"Uri": "/api/v2/image/sxDkbVM-0!pointofinterest",
"Locator": "PointOfInterest",
"LocatorType": "Object",
"UriDescription": "Point of interest for image",
"EndpointType": "PointOfInterest"
},
"PointOfInterestCrops": {
"Uri": "/api/v2/image/sxDkbVM-0!poicrops",
"Locator": "PointOfInterestCrops",
"LocatorType": "List",
"UriDescription": "PointOfInterest Crops for image",
"EndpointType": "PointOfInterestCrops"
},
"Regions": {
"Uri": "/api/v2/image/sxDkbVM-0!regions",
"Locator": "Region",
"LocatorType": "Objects",
"UriDescription": "Regions for image",
"EndpointType": "Regions"
},
"ImageMetadata": {
"Uri": "/api/v2/image/sxDkbVM-0!metadata",
"Locator": "ImageMetadata",
"LocatorType": "Object",
"UriDescription": "Metadata for image",
"EndpointType": "ImageMetadata"
},
"ImagePrices": {
"Uri": "/api/v2/image/sxDkbVM-0!prices",
"Locator": "CatalogSkuPrice",
"LocatorType": "Objects",
"UriDescription": "Purchasable Skus",
"EndpointType": "ImagePrices"
},
"ImagePricelistExclusions": {
"Uri": "/api/v2/image/sxDkbVM-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.0537,
"cycles": 1,
"objects": 0
}
}
},
"Code": 200,
"Message": "Ok"
}