Remove Image Metadata API - ApyHub

Remove Image Metadata API

File ManipulationImage Processing#images#metadata#remove
ApyHub
ApyHub
verified icon
30 atoms

About

This Utility API allows you to remove image metadata, such as tags, descriptions, copyright information, GPS coordinates, and more.
Removing metadata helps secure sensitive information, such as location data, and can reduce file size. This functionality ensures privacy protection by stripping away unnecessary or sensitive data embedded in images. By eliminating metadata, you can maintain a more streamlined file for storage, sharing, or publication without compromising personal or confidential details.
Try the API in the playground now and discover how effortlessly you can optimize your images.
Select API Endpoints
Input
Output

API Playground

API Documentation

input file: output file
POST
https://api.apyhub.com/processor/image/remove-metadata/file

Request example

1
curl --location --request POST 'https://api.apyhub.com/processor/image/remove-metadata/file' \
2
--header 'apy-token: {{token}}' \
3
--form 'image=@"stock-photo.jpg"'
4
--form 'group="gps"'
Method: POST
Content Type: multipart/form-data
Request Body
AttributeTypeMandatoryDescription
imageFileYesThe source image file in supported formats such as png, jpeg, jpg, bmp, tiff, gif, or webp.
groupStringNoIf set, only the metadata of the specified group will be removed. Currently, only the GPS group is supported for metadata removal.
keysArray of StringNoSpecifies the keys for which you want to delete metadata. For example, ["Title", "Author"] will remove metadata fields Title and Author from the image.
Note: By default, this API removes all writable metadata. To preserve specific metadata, either select a group or provide specific keys.
Sample Response
The method returns the cropped image in the output file mentioned in the URI.

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
200The request was successful.
401Required authentication information is either missing or not valid for the resource.
400Invalid input - the image file is corrupt or the height and width are not provided.
500If any unexpected error occurs while processing the request.

Authentication

All API requests to ApyHub services need to be authenticated. Currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from your workspace settings (on the left side of the navbar) and go to “API Keys".
Points to note:
  • Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
  • Use the apy-token as the header parameter to pass the token.
  • Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
  "error": {
3
    "code": 105,
4
    "message": "Invalid URL"
5
  }
6
}
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.
Table of contents
AboutAPI PlaygroundAPI DocumentationAuthenticationError codesRelated Utility APIsRelated Articles