Response [200 Ok]
| Uri | /api/v2/image/6zND24K-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]
- San Gregorio Light - San Mateo County, California
/api/v2/image/6zND24K-0
| Uri | /api/v2/image/6zND24K-0 | ||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| UriDescription | Image by key | ||||||||||||||||||||||||||||||||||
| Altitude | 0 | ||||||||||||||||||||||||||||||||||
| ArchivedMD5 | 7bc6003174a0f2dfcd8ea6e51db20018 | ||||||||||||||||||||||||||||||||||
| ArchivedSize | 7137392 | ||||||||||||||||||||||||||||||||||
| ArchivedUri | https://photos.smugmug.com/Page-Templates/Landscapes/i-6zND24K/0/MTHfTwfW6QMwCxhnqcJm7p6cq58rR7Gj6x2mC2qJK/D/071013-3319-SanGregLight-1085329928-O-D.jpg | ||||||||||||||||||||||||||||||||||
| CanBuy | true | ||||||||||||||||||||||||||||||||||
| CanEdit | false | ||||||||||||||||||||||||||||||||||
| CanShare | true | ||||||||||||||||||||||||||||||||||
| Caption | San Gregorio beach is a great place to watch the sunset. This was taken as the first storm of the season caused the water in the river to breach the sand dunes and flow to the sea. Bubbles of sea foam made a line in the sand as the last light came through the fog. | ||||||||||||||||||||||||||||||||||
| Collectable | true | ||||||||||||||||||||||||||||||||||
| Comments | true | ||||||||||||||||||||||||||||||||||
| ComponentFileTypes | |||||||||||||||||||||||||||||||||||
| Date | 2019-09-25T18:01:12+00:00 | ||||||||||||||||||||||||||||||||||
| DateTimeOriginal | 2007-10-14T00:32:00+00:00 | ||||||||||||||||||||||||||||||||||
| DateTimeUploaded | 2019-09-25T18:01:12+00:00 | ||||||||||||||||||||||||||||||||||
| EZProject | false | ||||||||||||||||||||||||||||||||||
| FileName | 071013-3319-SanGregLight-1085329928-O.jpg | ||||||||||||||||||||||||||||||||||
| Format | JPG | ||||||||||||||||||||||||||||||||||
| Hidden | false | ||||||||||||||||||||||||||||||||||
| ImageKey | 6zND24K | ||||||||||||||||||||||||||||||||||
| IsArchive | false | ||||||||||||||||||||||||||||||||||
| IsVideo | false | ||||||||||||||||||||||||||||||||||
| KeywordArray |
Array [17]
|
||||||||||||||||||||||||||||||||||
| Keywords | ocean; sea; sunrise; sunset; sand; beach; rock; sky; wave; seascape; landscape; san gregorio; san mateo; california; cliff; vacation; travel | ||||||||||||||||||||||||||||||||||
| LastUpdated | 2019-09-25T18:09:20+00:00 | ||||||||||||||||||||||||||||||||||
| Latitude | 0 | ||||||||||||||||||||||||||||||||||
| Longitude | 0 | ||||||||||||||||||||||||||||||||||
| OriginalHeight | 2904 | ||||||||||||||||||||||||||||||||||
| OriginalSize | 7137392 | ||||||||||||||||||||||||||||||||||
| OriginalWidth | 4368 | ||||||||||||||||||||||||||||||||||
| PreferredDisplayFileExtension | JPG | ||||||||||||||||||||||||||||||||||
| Processing | false | ||||||||||||||||||||||||||||||||||
| Protected | false | ||||||||||||||||||||||||||||||||||
| Serial | 0 | ||||||||||||||||||||||||||||||||||
| ShowKeywords | true | ||||||||||||||||||||||||||||||||||
| Status | Open | ||||||||||||||||||||||||||||||||||
| SubStatus | NFS | ||||||||||||||||||||||||||||||||||
| ThumbnailUrl | https://photos.smugmug.com/Page-Templates/Landscapes/i-6zND24K/0/K58vFFSmLRZ4N45qhZc5mb7SChzqWSTpWQ7M6SB3V/Th/071013-3319-SanGregLight-1085329928-O-Th.jpg | ||||||||||||||||||||||||||||||||||
| Title | San Gregorio Light - San Mateo County, California | ||||||||||||||||||||||||||||||||||
| UploadKey | 8763608652 | ||||||||||||||||||||||||||||||||||
| Watermark | No | ||||||||||||||||||||||||||||||||||
| Watermarked | false |
Formatted Values
Caption [html, text]
| html | San Gregorio beach is a great place to watch the sunset. This was taken as the first storm of the season caused the water in the river to breach the sand dunes and flow to the sea. Bubbles of sea foam made a line in the sand as the last light came through the fog. |
|---|---|
| text | San Gregorio beach is a great place to watch the sunset. This was taken as the first storm of the season caused the water in the river to breach the sand dunes and flow to the sea. Bubbles of sea foam made a line in the sand as the last light came through the fog. |
FileName [html, text]
| html | 071013-3319-SanGregLight-1085329928-O.jpg |
|---|---|
| text | 071013-3319-SanGregLight-1085329928-O.jpg |
Uris
ImageComments
/api/v2/image/6zND24K-0!comments
| Uri | /api/v2/image/6zND24K-0!comments |
|---|---|
| UriDescription | Comments on image |
| EndpointType | ImageComments |
| Locator | Comment |
| LocatorType | Objects |
ImageMetadata
/api/v2/image/6zND24K-0!metadata
| Uri | /api/v2/image/6zND24K-0!metadata |
|---|---|
| UriDescription | Metadata for image |
| EndpointType | ImageMetadata |
| Locator | ImageMetadata |
| LocatorType | Object |
ImagePricelistExclusions
/api/v2/image/6zND24K-0!pricelistexclusions
| Uri | /api/v2/image/6zND24K-0!pricelistexclusions |
|---|---|
| UriDescription | Pricelist information for an image |
| EndpointType | ImagePricelistExclusions |
| Locator | ImagePricelistExclusions |
| LocatorType | Object |
ImagePrices
/api/v2/image/6zND24K-0!prices
| Uri | /api/v2/image/6zND24K-0!prices |
|---|---|
| UriDescription | Purchasable Skus |
| EndpointType | ImagePrices |
| Locator | CatalogSkuPrice |
| LocatorType | Objects |
ImageSizeDetails
/api/v2/image/6zND24K-0!sizedetails
| Uri | /api/v2/image/6zND24K-0!sizedetails |
|---|---|
| UriDescription | Detailed size information for image |
| EndpointType | ImageSizeDetails |
| Locator | ImageSizeDetails |
| LocatorType | Object |
ImageSizes
/api/v2/image/6zND24K-0!sizes
| Uri | /api/v2/image/6zND24K-0!sizes |
|---|---|
| UriDescription | Sizes available for image |
| EndpointType | ImageSizes |
| Locator | ImageSizes |
| LocatorType | Object |
LargestImage
/api/v2/image/6zND24K-0!largestimage
| Uri | /api/v2/image/6zND24K-0!largestimage |
|---|---|
| UriDescription | Largest size available for image |
| EndpointType | LargestImage |
| Locator | LargestImage |
| LocatorType | Object |
PointOfInterest
/api/v2/image/6zND24K-0!pointofinterest
| Uri | /api/v2/image/6zND24K-0!pointofinterest |
|---|---|
| UriDescription | Point of interest for image |
| EndpointType | PointOfInterest |
| Locator | PointOfInterest |
| LocatorType | Object |
PointOfInterestCrops
/api/v2/image/6zND24K-0!poicrops
| Uri | /api/v2/image/6zND24K-0!poicrops |
|---|---|
| UriDescription | PointOfInterest Crops for image |
| EndpointType | PointOfInterestCrops |
| Locator | PointOfInterestCrops |
| LocatorType | List |
Regions
/api/v2/image/6zND24K-0!regions
| Uri | /api/v2/image/6zND24K-0!regions |
|---|---|
| UriDescription | Regions for image |
| EndpointType | Regions |
| Locator | Region |
| LocatorType | Objects |
Request
| Uri | /api/v2/image/6zND24K-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/6zND24K-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": "6zND24K-0",
"param_validator": {}
}
]
},
"Response": {
"Uri": "/api/v2/image/6zND24K-0",
"Locator": "Image",
"LocatorType": "Object",
"Image": {
"Title": "San Gregorio Light - San Mateo County, California",
"Caption": "San Gregorio beach is a great place to watch the sunset. This was taken as the first storm of the season caused the water in the river to breach the sand dunes and flow to the sea. Bubbles of sea foam made a line in the sand as the last light came through the fog.",
"Keywords": "ocean; sea; sunrise; sunset; sand; beach; rock; sky; wave; seascape; landscape; san gregorio; san mateo; california; cliff; vacation; travel",
"KeywordArray": [
"ocean",
"sea",
"sunrise",
"sunset",
"sand",
"beach",
"rock",
"sky",
"wave",
"seascape",
"landscape",
"san gregorio",
"san mateo",
"california",
"cliff",
"vacation",
"travel"
],
"Watermark": "No",
"Latitude": "0",
"Longitude": "0",
"Altitude": 0,
"Hidden": false,
"ThumbnailUrl": "https://photos.smugmug.com/Page-Templates/Landscapes/i-6zND24K/0/K58vFFSmLRZ4N45qhZc5mb7SChzqWSTpWQ7M6SB3V/Th/071013-3319-SanGregLight-1085329928-O-Th.jpg",
"FileName": "071013-3319-SanGregLight-1085329928-O.jpg",
"Processing": false,
"UploadKey": "8763608652",
"Date": "2019-09-25T18:01:12+00:00",
"DateTimeUploaded": "2019-09-25T18:01:12+00:00",
"DateTimeOriginal": "2007-10-14T00:32:00+00:00",
"Format": "JPG",
"OriginalHeight": 2904,
"OriginalWidth": 4368,
"OriginalSize": 7137392,
"LastUpdated": "2019-09-25T18:09:20+00:00",
"Collectable": true,
"IsArchive": false,
"IsVideo": false,
"ComponentFileTypes": [],
"CanEdit": false,
"CanBuy": true,
"Protected": false,
"EZProject": false,
"Watermarked": false,
"ImageKey": "6zND24K",
"Serial": 0,
"ArchivedUri": "https://photos.smugmug.com/Page-Templates/Landscapes/i-6zND24K/0/MTHfTwfW6QMwCxhnqcJm7p6cq58rR7Gj6x2mC2qJK/D/071013-3319-SanGregLight-1085329928-O-D.jpg",
"ArchivedSize": 7137392,
"ArchivedMD5": "7bc6003174a0f2dfcd8ea6e51db20018",
"Status": "Open",
"SubStatus": "NFS",
"CanShare": true,
"Comments": true,
"ShowKeywords": true,
"FormattedValues": {
"Caption": {
"html": "San Gregorio beach is a great place to watch the sunset. This was taken as the first storm of the season caused the water in the river to breach the sand dunes and flow to the sea. Bubbles of sea foam made a line in the sand as the last light came through the fog.",
"text": "San Gregorio beach is a great place to watch the sunset. This was taken as the first storm of the season caused the water in the river to breach the sand dunes and flow to the sea. Bubbles of sea foam made a line in the sand as the last light came through the fog."
},
"FileName": {
"html": "071013-3319-SanGregLight-1085329928-O.jpg",
"text": "071013-3319-SanGregLight-1085329928-O.jpg"
}
},
"PreferredDisplayFileExtension": "JPG",
"Uri": "/api/v2/image/6zND24K-0",
"UriDescription": "Image by key",
"Uris": {
"LargestImage": {
"Uri": "/api/v2/image/6zND24K-0!largestimage",
"Locator": "LargestImage",
"LocatorType": "Object",
"UriDescription": "Largest size available for image",
"EndpointType": "LargestImage"
},
"ImageSizes": {
"Uri": "/api/v2/image/6zND24K-0!sizes",
"Locator": "ImageSizes",
"LocatorType": "Object",
"UriDescription": "Sizes available for image",
"EndpointType": "ImageSizes"
},
"ImageSizeDetails": {
"Uri": "/api/v2/image/6zND24K-0!sizedetails",
"Locator": "ImageSizeDetails",
"LocatorType": "Object",
"UriDescription": "Detailed size information for image",
"EndpointType": "ImageSizeDetails"
},
"PointOfInterest": {
"Uri": "/api/v2/image/6zND24K-0!pointofinterest",
"Locator": "PointOfInterest",
"LocatorType": "Object",
"UriDescription": "Point of interest for image",
"EndpointType": "PointOfInterest"
},
"PointOfInterestCrops": {
"Uri": "/api/v2/image/6zND24K-0!poicrops",
"Locator": "PointOfInterestCrops",
"LocatorType": "List",
"UriDescription": "PointOfInterest Crops for image",
"EndpointType": "PointOfInterestCrops"
},
"Regions": {
"Uri": "/api/v2/image/6zND24K-0!regions",
"Locator": "Region",
"LocatorType": "Objects",
"UriDescription": "Regions for image",
"EndpointType": "Regions"
},
"ImageComments": {
"Uri": "/api/v2/image/6zND24K-0!comments",
"Locator": "Comment",
"LocatorType": "Objects",
"UriDescription": "Comments on image",
"EndpointType": "ImageComments"
},
"ImageMetadata": {
"Uri": "/api/v2/image/6zND24K-0!metadata",
"Locator": "ImageMetadata",
"LocatorType": "Object",
"UriDescription": "Metadata for image",
"EndpointType": "ImageMetadata"
},
"ImagePrices": {
"Uri": "/api/v2/image/6zND24K-0!prices",
"Locator": "CatalogSkuPrice",
"LocatorType": "Objects",
"UriDescription": "Purchasable Skus",
"EndpointType": "ImagePrices"
},
"ImagePricelistExclusions": {
"Uri": "/api/v2/image/6zND24K-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.06371,
"cycles": 1,
"objects": 0
}
}
},
"Code": 200,
"Message": "Ok"
}