Response [200 Ok]
| Uri | /api/v2/image/LT8fnPB-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]
- A man bonds with his fish
/api/v2/image/LT8fnPB-0
| Uri | /api/v2/image/LT8fnPB-0 |
|---|---|
| UriDescription | Image by key |
| Altitude | 0 |
| CanBuy | false |
| CanEdit | false |
| CanShare | false |
| Caption | An otter's-eye view, in the light of the election of the Bishan otters as the country's representatives in her 51st year of independence.<br><span style="font-size:75%">©Yangchen Lin</span> |
| Collectable | false |
| Comments | false |
| ComponentFileTypes | |
| Date | 2016-08-17T11:55:14+00:00 |
| DateTimeOriginal | 2016-08-13T16:04:25+00:00 |
| DateTimeUploaded | 2016-08-17T11:55:14+00:00 |
| EZProject | false |
| FileName | singapore_chinatown_wet_market_fishmonger.jpg |
| Format | JPG |
| Hidden | false |
| ImageKey | LT8fnPB |
| IsArchive | false |
| IsVideo | false |
| KeywordArray | |
| Keywords | empty string |
| LastUpdated | 2016-08-17T12:26:44+00:00 |
| Latitude | 0 |
| Longitude | 0 |
| OriginalHeight | 3456 |
| OriginalWidth | 5184 |
| PreferredDisplayFileExtension | JPG |
| Processing | false |
| Protected | false |
| Serial | 0 |
| ShowKeywords | false |
| ThumbnailUrl | https://photos.smugmug.com/photos/i-LT8fnPB/0/Th/i-LT8fnPB-Th.jpg |
| Title | A man bonds with his fish |
| UploadKey | 5158144082 |
| Watermark | No |
| Watermarked | false |
Formatted Values
Caption [html, text]
| html | An otter's-eye view, in the light of the election of the Bishan otters as the country's representatives in her 51st year of independence.<br><span style="font-size:75%">©Yangchen Lin</span> |
|---|---|
| text | An otter's-eye view, in the light of the election of the Bishan otters as the country's representatives in her 51st year of independence.©Yangchen Lin |
FileName [html, text]
| html | singapore_chinatown_wet_market_fishmonger.jpg |
|---|---|
| text | singapore_chinatown_wet_market_fishmonger.jpg |
Uris
ImagePricelistExclusions
/api/v2/image/LT8fnPB-0!pricelistexclusions
| Uri | /api/v2/image/LT8fnPB-0!pricelistexclusions |
|---|---|
| UriDescription | Pricelist information for an image |
| EndpointType | ImagePricelistExclusions |
| Locator | ImagePricelistExclusions |
| LocatorType | Object |
ImagePrices
/api/v2/image/LT8fnPB-0!prices
| Uri | /api/v2/image/LT8fnPB-0!prices |
|---|---|
| UriDescription | Purchasable Skus |
| EndpointType | ImagePrices |
| Locator | CatalogSkuPrice |
| LocatorType | Objects |
ImageSizeDetails
/api/v2/image/LT8fnPB-0!sizedetails
| Uri | /api/v2/image/LT8fnPB-0!sizedetails |
|---|---|
| UriDescription | Detailed size information for image |
| EndpointType | ImageSizeDetails |
| Locator | ImageSizeDetails |
| LocatorType | Object |
ImageSizes
/api/v2/image/LT8fnPB-0!sizes
| Uri | /api/v2/image/LT8fnPB-0!sizes |
|---|---|
| UriDescription | Sizes available for image |
| EndpointType | ImageSizes |
| Locator | ImageSizes |
| LocatorType | Object |
LargestImage
/api/v2/image/LT8fnPB-0!largestimage
| Uri | /api/v2/image/LT8fnPB-0!largestimage |
|---|---|
| UriDescription | Largest size available for image |
| EndpointType | LargestImage |
| Locator | LargestImage |
| LocatorType | Object |
PointOfInterest
/api/v2/image/LT8fnPB-0!pointofinterest
| Uri | /api/v2/image/LT8fnPB-0!pointofinterest |
|---|---|
| UriDescription | Point of interest for image |
| EndpointType | PointOfInterest |
| Locator | PointOfInterest |
| LocatorType | Object |
PointOfInterestCrops
/api/v2/image/LT8fnPB-0!poicrops
| Uri | /api/v2/image/LT8fnPB-0!poicrops |
|---|---|
| UriDescription | PointOfInterest Crops for image |
| EndpointType | PointOfInterestCrops |
| Locator | PointOfInterestCrops |
| LocatorType | List |
Regions
/api/v2/image/LT8fnPB-0!regions
| Uri | /api/v2/image/LT8fnPB-0!regions |
|---|---|
| UriDescription | Regions for image |
| EndpointType | Regions |
| Locator | Region |
| LocatorType | Objects |
Request
| Uri | /api/v2/image/LT8fnPB-0?_accept=text%2Fhtml |
|---|---|
| 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 | |
| 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/LT8fnPB-0?_accept=text%2Fhtml"
},
"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": "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": "LT8fnPB-0",
"param_validator": {}
}
]
},
"Response": {
"Uri": "/api/v2/image/LT8fnPB-0",
"Locator": "Image",
"LocatorType": "Object",
"Image": {
"Title": "A man bonds with his fish",
"Caption": "An otter's-eye view, in the light of the election of the Bishan otters as the country's representatives in her 51st year of independence.<br><span style=\"font-size:75%\">\u00a9Yangchen Lin</span>",
"Keywords": "",
"KeywordArray": [],
"Watermark": "No",
"Latitude": "0",
"Longitude": "0",
"Altitude": 0,
"Hidden": false,
"ThumbnailUrl": "https://photos.smugmug.com/photos/i-LT8fnPB/0/Th/i-LT8fnPB-Th.jpg",
"FileName": "singapore_chinatown_wet_market_fishmonger.jpg",
"Processing": false,
"UploadKey": "5158144082",
"Date": "2016-08-17T11:55:14+00:00",
"DateTimeUploaded": "2016-08-17T11:55:14+00:00",
"DateTimeOriginal": "2016-08-13T16:04:25+00:00",
"Format": "JPG",
"OriginalHeight": 3456,
"OriginalWidth": 5184,
"LastUpdated": "2016-08-17T12:26:44+00:00",
"Collectable": false,
"IsArchive": false,
"IsVideo": false,
"ComponentFileTypes": [],
"CanEdit": false,
"CanBuy": false,
"Protected": false,
"EZProject": false,
"Watermarked": false,
"ImageKey": "LT8fnPB",
"Serial": 0,
"CanShare": false,
"Comments": false,
"ShowKeywords": false,
"FormattedValues": {
"Caption": {
"html": "An otter's-eye view, in the light of the election of the Bishan otters as the country's representatives in her 51st year of independence.<br><span style=\"font-size:75%\">\u00a9Yangchen Lin</span>",
"text": "An otter's-eye view, in the light of the election of the Bishan otters as the country's representatives in her 51st year of independence.\u00a9Yangchen Lin"
},
"FileName": {
"html": "singapore_chinatown_wet_market_fishmonger.jpg",
"text": "singapore_chinatown_wet_market_fishmonger.jpg"
}
},
"PreferredDisplayFileExtension": "JPG",
"Uri": "/api/v2/image/LT8fnPB-0",
"UriDescription": "Image by key",
"Uris": {
"LargestImage": {
"Uri": "/api/v2/image/LT8fnPB-0!largestimage",
"Locator": "LargestImage",
"LocatorType": "Object",
"UriDescription": "Largest size available for image",
"EndpointType": "LargestImage"
},
"ImageSizes": {
"Uri": "/api/v2/image/LT8fnPB-0!sizes",
"Locator": "ImageSizes",
"LocatorType": "Object",
"UriDescription": "Sizes available for image",
"EndpointType": "ImageSizes"
},
"ImageSizeDetails": {
"Uri": "/api/v2/image/LT8fnPB-0!sizedetails",
"Locator": "ImageSizeDetails",
"LocatorType": "Object",
"UriDescription": "Detailed size information for image",
"EndpointType": "ImageSizeDetails"
},
"PointOfInterest": {
"Uri": "/api/v2/image/LT8fnPB-0!pointofinterest",
"Locator": "PointOfInterest",
"LocatorType": "Object",
"UriDescription": "Point of interest for image",
"EndpointType": "PointOfInterest"
},
"PointOfInterestCrops": {
"Uri": "/api/v2/image/LT8fnPB-0!poicrops",
"Locator": "PointOfInterestCrops",
"LocatorType": "List",
"UriDescription": "PointOfInterest Crops for image",
"EndpointType": "PointOfInterestCrops"
},
"Regions": {
"Uri": "/api/v2/image/LT8fnPB-0!regions",
"Locator": "Region",
"LocatorType": "Objects",
"UriDescription": "Regions for image",
"EndpointType": "Regions"
},
"ImagePrices": {
"Uri": "/api/v2/image/LT8fnPB-0!prices",
"Locator": "CatalogSkuPrice",
"LocatorType": "Objects",
"UriDescription": "Purchasable Skus",
"EndpointType": "ImagePrices"
},
"ImagePricelistExclusions": {
"Uri": "/api/v2/image/LT8fnPB-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.04182,
"cycles": 1,
"objects": 0
}
}
},
"Code": 200,
"Message": "Ok"
}