Retouched.ai

Retouched.ai is an API-driven platform offering professional image editing services designed to integrate easily into various applications. Its primary functionalities include background removal, color correction, and image retouching. Users can submit images for processing, which allows them to streamline editing workflows, especially valuable for industries like e-commerce and digital marketing where high-quality images are crucial.

How and Why It’s Used:

  • Purpose: Retouched.ai enables companies to automate and enhance their image processing tasks without requiring manual editing. This automation is particularly useful for businesses needing to manage large volumes of images, as it allows for efficient, consistent, and high-quality outputs.
  • Usage Process: Through Retouched.ai’s API endpoints, users can:
    • Authenticate their accounts to securely access services.
    • Upload images with options for specific processing requests, like background removal or additional color adjustments.
    • Retrieve processed images via FTP/SFTP, ensuring safe and seamless file delivery.

This setup supports a range of applications in client systems, where users can also add notes or attachments to images, allowing customization and precision in image editing requirements.

Retouched.ai API Resources

Welcome to the Retouched.AI API documentation. Through this set of APIs, users can easily integrate professional image editing services into their applications. Users can sign up, verify their accounts, reset passwords, and submit images for services such as background removal, color correction, and retouching etc. Additionally, users can include notes and file attachments for relevant information.

API Endpoints Overview

2.1 Authentication and User Account Management

  • System Sign-Up (POST): Registers a new user account.
  • Set Password (POST): Allows the user to set or reset their password.
  • System Sign-In (POST): Authenticates the user and provides a session token.
  • Reset Password Request (POST): Initiates a password reset process.
  • Reset Password (POST): Completes the password reset process.

2.2 Image Processing

  • Upload Image (POST): Submits one or multiple images for processing. Each image in the bulk can have add-on services like background removal, retouching, or color correction, etc.
  • Send Processed Images via FTP/SFTP (POST): Sends the processed images back to the user through FTP or SFTP

Detailed Endpoint Descriptions

3.1 Sign-Up

Listing 1: System Sign-Up Request and Response

POST /api/2023-02/system-sign-up
Request:
{
  "email": "[email protected]"
}
Response:
{
  "message": "Sign-up Successful.",
  "status": "success",
  "status_code": 200
}

3.2 Set Password

Listing 2: Set Password Request and Response

POST /api/2023-02/system-sign-up
Request:
{
  "verified_token": "VerifiedToken"
  "password": "ExamplePassword"
  "confirm_password": "ExamplePassword"
}
Response:
{
  "message": "SUCCESS : User information updated successfully.",
  "status": "success",
  "status_code": 200
}

3.3 Sign In

Listing 3: System Sign-In Request and Response

POST /api/2023-02/system-sign-up
Request:
{
  "email": "[email protected]"
  "password": "ExamplePassword"
}
Response:
{
  "message": "SUCCESS : Successfully logged in.",
  "status": "success",
  "status_code": 200
}

3.4 Upload Image

Listing 4: Upload Image Request and Response

POST /v.03.13.23/upload - image
Request (form-data):
order_master_id : { order_master_id }
file : { image_file_path }
add_on_services : [" remove_bg ", " retouch ", " color_correction "] (optional)
notes : { additional_notes } (optional)
attachments : { attachment_file_path } (optional)
Authorization : { user_token }

Response:
{
  "message": "Upload Successful",
  "status": "success",
  "status_code": 200
}

3.5 Send Processed Images via FTP/SFTP

Listing 5: Send Processed Images via FTP/SFTP Request and Response

POST /v.03.13.23/send-processed-images
Request:
{
  "ftp_details": {
    "host": "ftp.example.com",
    "username": "user",
    "password": "password",
    "protocol": "sftp" or "ftp"
  },
  "image_ids": ["image_id_1", "image_id_2"]
}
Response:
{
  "message": "Images successfully sent via FTP/SFTP.",
  "status": "success",
  "status_code": 200
}

Conclusion

This documentation provides a foundational understanding for integrating with the Retouched.AI services. For further assistance, please email our technical support team at [email protected]

© 2025 The Kow Company Ltd. All rights reserved.