{"templateId":"api_docs","sharedDataIds":{"apiDocsStore":"api-docs-reference/ai_watermark_removal.yaml","sidebar":"sidebar-reference/sidebars.yaml"},"props":{"definitionId":"reference/ai_watermark_removal.yaml","settings":{"baseUrlPath":"/reference/ai_watermark_removal"},"disableAutoScroll":true,"seo":{"title":"AI Watermark Removal","description":"YouCam API documentation by Perfect Corp. Learn how to use Skin analysis API, Virtual try-on API, Image editing API, and Video generative AI APIs.","siteUrl":"https://docs.perfectcorp.com","keywords":"AI Skin Analysis, AI Clothes, AI Hairstyle, AI Outfits","image":"/assets/favicon.cd6fa4d833b2a573b3c6dae68386b293da205b203402cb0c97b80bd2acc07ea2.8351e24f.png"},"dynamicMarkdocComponents":[],"metadata":{"type":"openapi","title":"AI Watermark Removal","version":"","description":"# Overview\nAI-Powered Watermark Removal\n\nReliably detect and erase watermarks, logos, and other marks while preserving the image's original quality and details.\n\n    > Use the tool responsibly to avoid unethical applications, such as removing watermarks for unauthorized commercial use. Respect the intended purpose of the image and adhere to fair use principles.\n\n![](https://d32qvgpd29lguw.cloudfront.net/Watermark_Remover_BA_Image_24bf9f2ed1.png)\n\n---\n\n## Integration Guide\n\n* AI Watermark Removal Usage Guide\n\nThis guide explains how to upload images, prepare reference outfits, and create virtual try-on tasks using the AI Watermark Removal.\n\n***\n\n   * Step 1. Upload a File Using the File API\n\nUse the **File API** (`/s2s/v2.0/file`) to upload a target image.\n\n***\n\n   * Step 2. Retrieve File API Response\n\nThe response includes:\n\n*   `file_id` for creating an AI task.\n*   `requests.url` for uploading the actual image file.\n\n***\n\n   * Step 3. Upload Image to Provided URL\n\nUse the `requests.url` from the File API response to upload the image:\n\n***\n\n   * Step 4. Create an AI Task\n\nUse the **AI Task API** (`/s2s/v2.0/task/wmk-removal`) to create an AI task.\n\n***\n\n   * Step 5. Poll for Task Result\n\nUse the task ID to check the status:\n\n```bash\ncurl --request GET \\\n  --url https://yce-api-01.makeupar.com/s2s/v2.0/task/wmk-removal/<YOUR_TASK_ID> \\\n  --header 'Authorization: Bearer YOUR_API_KEY' \\\n  --header 'content-type: application/json'\n```\n\n***\n\n   * Step 6. Retrieve Result\n\nA successful response includes a download URL for the result image:\n\n```json\n{\n  \"status\": 200,\n  \"data\": {\n    \"error\": null,\n    \"results\": {\n \"url\": \"https://yce-us.s3-accelerate.amazonaws.com/demo/ttl30/...signature...\"\n    },\n    \"task_status\": \"success\"\n  }\n}\n```\n\nInvalid API Key error response:\n\n```json\n{\n  \"status\": 401,\n  \"error\": \"Unauthorized\",\n  \"error_code\": \"InvalidAccessToken\"\n}\n```\n\n---\n\nUse cases:\n![](https://d32qvgpd29lguw.cloudfront.net/Watermark_Remover_BA_2_c8bbf561af.png)\n\n\n\n## File Specs & Errors\n* Supported Formats & Dimensions\n\n|Type|Supported Dimensions|Supported File Size|Supported Formats|\n|  ---- | ---- | ---- | ---- |\n| AI Watermark Removal | max side 4096 px | < 10MB | jpg/png |\n\n    > Removing watermarks can be illegal if done without the copyright owner’s consent or for unauthorized purposes. Always ensure you have proper rights to the image.\n\n* Error Codes\n\n| Error code | Description |\n| ---------- | ----------- |\n| invalid_parameter |The parameter(s) is missing or invalid. |\n| error_download_image | The image could not be downloaded. |\n| exceed_max_filesize | The image is too large. The file size must not exceed 10 MB. The long side must not exceed 4096 pixels. |\n| error_below_min_image_size | The image is too small. The long side must be at least 128 pixels. |\n| error_nsfw_content_detected | Potential NSFW content was detected in the result image. |\n| error_editing_failed | The editing process failed because the result image is too similar to the source image. |\n| unknown_internal_error | Something went wrong on our end while processing this request. |\n\n\n* Environment & Dependency\n\n| Sample Code Language / Tool | Recommended Runtime Versions |\n|---|---|\n| cURL | - bash >= 3.2</br>   - curl >= 7.58 (modern TLS/HTTP support)</br>   - jq >= 1.6 (robust JSON parsing) |\n| Node.js (JavaScript) | Node >= 18 (for global fetch) |\n| JavaScript | - Chrome / Edge >= 80</br>   - Firefox >= 74</br>   - Safari >= 13.1 |\n| PHP | PHP >= 7.4 (for modern TLS/compat), ext-curl (recommended) or allow_url_fopen=On + ext-openssl, ext-json |\n| Python | Python >= 3.10 (for f-strings), requests >= 2.20.0 |\n| Java | Java 11+ (for HttpClient), Jackson Databind >= 2.12.0 |\n\n---\n\n## Unit Consumption\n\n| AI Feature | Unit Consumed |\n|---|---|\n| AI Watermark Removal | 1 |\n\n---\n"},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"docs.perfectcorp.com","port":4000,"ipAddress":"216.73.216.110"},"lang":"en","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"master"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/reference/ai_watermark_removal","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}