XMP parser¶
This API allows you to input an image URL and check the key metadata injected in the content. You need both the Capture Token and the URL of the API for this process. If you do not already have a Capture Token yet, please follow the instruction provided to create one.
API Endpoint: https://eo56wht9ud2ooza.m.pipedream.net
Cost: 0.01 NUM
Method: POST
Description:
This API endpoint allows developers to get the key metadata injected in the image.
Authentication:
This API requires a valid token for Authorization. The token should be passed in the headers of the request using the following format: "Authorization: token YOUR_CAPTURE_TOKEN"
Header:
Authorization: token $YOUR_CAPTURE_TOKEN (required)
Content-Type: application/json
Request Body (required):
fileURL (string): URL of the image file.
Example:
curl -X GET "https://eo56wht9ud2ooza.m.pipedream.net" \
-H "Content-Type: application/json" \
-H "Authorization: token YOUR_CAPTURE_TOKEN" \
-d '{
"fileURL": URL_OF_FILE
}'
Response:
{
"abstract": "Cold Snow",
"headline": "20231121 the first snow in Niseko",
"license": {
"name": "CC-BY-NC-ND-4.0",
"document": "https://creativecommons.org/licenses/by-nc-nd/4.0/legalcode"
},
"assetCreator": "Mei Yang",
"integrity_created_at": "2023:11:21 14:51:12",
"integrity_location_latitude": 63.27653,
"integrity_location_longitude": 28.7655,
"integrity_recorder": "Mei Yang",
"integrity_device_model": "NIKON Z 6_2",
"integrity_device_manufacturer": "NIKON CORPORATION",
"nid": string, // File Nid
"fileSize": int, // File size
"sha256": string // SHA256 checksum of the file
}
200: Check API successful.
400: Bad request
401: Unauthorized
403: Forbidden
500: Internal Server Error
In this example, you would replace YOUR_CAPTURE_TOKEN
with your actual Capture token and URL_OF_FILE
with the URL you want to check.
How does API read the metadata¶
This API uses piexif
python module to read the metadata injected in the image. The following table shows the mapping between the raw fields defined by EXIF and the response.
Raw data | Return field | Description | Type |
---|---|---|---|
ImageDescription | abstract | Short description of the content | string |
XPTitle | headline | Title of the content | string |
Artist | assetCreator | The name of the camera owner, photographer or image creator | string |
DateTimeOriginal | integrity_created_at | The date and time when the original image data was generated. | timestamp |
GPSInfo.GPSLongitude | integrity_location_longitude | Location longitude | float |
GPSInfo.GPSLatitude | integrity_location_latitude | Location latitude | float |
Model | integrity_device_model | The model name or model number of the equipment. | string |
Make | integrity_device_manufacturer | The manufacturer of the recording equipment. | string |
XPAuthor | integrity_recorder | The person who record the metadata information | string |