Get Image Metadata
Image → Get Image Metadata
The Get Image Metadata API extracts metadata from an image. You send the image as Base64 (docContent), docName, and optionally imageType (JPG, PNG) and async. The API returns JSON with dimensions, format, EXIF data, color info, and other properties. Use the tester below to try it; more details are in the sections that follow.
Try the Get Image Metadata API
Endpoint: POST /api/v2/GetImageMetadata · Required: api-key, docContent, docName
Use the form below to send your API key and image (Base64). The response is JSON with metadata (dimensions, format, EXIF, etc.). No code required, fill the fields and click Send request.
Overview, parameters, and use cases
- Overview
- Parameters
- Use cases
What is Get Image Metadata?
This endpoint extracts metadata from an image. You provide the image (Base64), docName, and optionally imageType (JPG, PNG). The API returns JSON with dimensions (width, height), format, EXIF data (if present), file properties, color information, and other metadata.
Key features
- Dimensions and format: Width, height, image type.
- EXIF: Camera, date, GPS, and other EXIF fields when available.
- Async: Use async for large images.
Use when you need image properties for search, indexing, or workflows. For EXIF-based rotation use Rotate Image by EXIF Data; to remove EXIF use Remove EXIF Tags from Image.
API parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| api-key | string | Yes | Your PDF4me API key, Base64 encoded. Get it from the dashboard. |
| docContent | base64 | Yes | Image file content (Base64). Supported: JPG, PNG. |
| docName | string | Yes | Image file name. |
| imageType | string | No | Image type: JPG or PNG. |
| async | boolean | No | Enable asynchronous processing. |
When to use Get Image Metadata
- Search and indexing: Use dimensions, format, and EXIF for cataloging.
- Workflows: Route or validate images based on metadata.
- Compliance: Read creation date, device, or location from EXIF.
For request/response schemas and code samples, see Get Image Metadata in the PDF4me API docs.
Prerequisites
Before using this endpoint, make sure you have:
- A valid PDF4me API key (Get your API Key)
- An image file (JPG, PNG) in Base64 format
Response Format
The API returns JSON with metadata: dimensions, format, EXIF data (if available), file properties, color information, and other metadata.