Retouch API

The Retouch API allows users to erase unwanted objects or elements from an image. By leveraging advanced AI algorithms, it intelligently fills the removed areas with contextually appropriate details, making it ideal for photo editing and retouching.

For additional details on each parameter and its optimal use, check out the Retouch API Reference.

Key Features

• Object Removal: Effortlessly erase unwanted elements such as blemishes, objects, or distractions from any part of the image.

• Contextual Filling: AI intelligently reconstructs the removed areas, maintaining the original image’s style, colors, textures, and lighting.

• Precision Editing: Fine-tune removal with adjustable parameters to ensure accuracy and control over the editing process.

• Support for Diverse Image Types: Compatible with a wide range of image formats, including photographs, digital art, and illustrations.

• High-Resolution Output: Delivers high-quality results that preserve the image’s resolution and detail.

• Batch Processing: Handle multiple images simultaneously, streamlining workflows for large projects.

Strategic Value

The Retouch API provides unparalleled efficiency and quality in image editing, making it an essential tool for various creative and professional workflows. It eliminates the need for manual retouching, saving time and resources while ensuring consistent, high-quality results. By automating the retouching process, businesses can enhance their visual content swiftly and effectively, maintaining a competitive edge in their respective markets.

Industries

• Photography: Enhance photos by removing imperfections, unwanted objects, or distractions to produce polished and professional images.

• E-commerce and Retail: Clean product images by eliminating background clutter or unwanted elements, ensuring products stand out.

• Media and Entertainment: Refine visuals for publications, advertisements, and digital content, enhancing overall quality and appeal.

• Marketing and Advertising: Create flawless images for campaigns by removing elements that may detract from the message or aesthetic.

• Real Estate: Improve property photos by removing distractions, making spaces appear more appealing to potential buyers.

• Fashion and Beauty: Retouch images by removing blemishes or unwanted accessories, highlighting the subject's features effectively.

Endpoint

The endpoint for Image Retouch API is

POST https://api.vyro.ai/v2/image/edits/remove

Headers

You need to pass the following headers along with the request.

Authorization

Pass your API token as a Bearer token in the Authorization header. Refer to the Authorization Section for guidance on managing your API keys.

Authorization: Bearer {{API_TOKEN}}

Request Body Parameters

Below are the parameters that allow for a high degree of customization when resizing images. Click on each parameter to learn more about its use and best practices:

image

Upload the image you want to retouch. The image should be provided in binary format or as a file path. Use this field to provide the original image that the API will transform.

image=@"path/to/your/image.jpg"

mask

Upload the mask image indicating the areas to be removed.. The image should be provided in binary format or as a file path.

mask=@"path/to/your/image.jpg"

Example API Call

Here’s a sample curl request that uses the parameters above:

curl --location --request POST 'https://api.vyro.ai/v2/image/edits/remove' \
--header 'Authorization: Bearer {{API_TOKEN}}' \
--form 'image=@"path/to/your/image.jpg"' \
--form 'mask=@"path/to/your/image.jpg"'

For additional details on each parameter and its optimal use, check out the Retouch API Reference.

Response

Upon a successful request, the API returns a binary image file which can be directly rendered or saved.

Response Attributes:

• image (binary): The generated image in binary format. You can decode and display or store it based on your application needs.

Error Handling

In case of errors, the response includes status codes and error messages. See the Errors and Troubleshooting section for help with interpreting and resolving these errors.