{ "openapi": "3.0.0", "info": { "title": "YouCam Online Editor AI APIs", "version": "v1.5", "termsOfService": "https://www.perfectcorp.com/perfectbeauty/youcam/terms-of-service", "contact": { "email": "YouCamOnlineEditor_API@perfectcorp.com" }, "license": { "name": "Privacy policy", "url": "https://www.perfectcorp.com/youcamapps/youcam/privacy-policy.html" }, "x-logo": { "url": "https://yce.perfectcorp.com/assets/images/logo/logo_YC_OnlineEditor_d_ENU_dt.svg", "altText": "YouCam Online Editor", "href": "https://yce.perfectcorp.com" }, "description": "# API Document\nLast modified: Oct. 23, 2025 144c984\n\nThe YouCam Online Editor AI APIs are series of AI effects that let you beautify your photos, as well as generate amazing aesthetic creations beyond human imagination. Let the magic begin.\n\nPLEASE NOTE that by reading this API documentation, or by setting up code pursuant to the instructions in this API documentation, you acknowledge it adheres to Perfect Corp's [Privacy policy](https://www.perfectcorp.com/youcamapps/youcam/privacy-policy.html), and [Terms of Service](https://www.perfectcorp.com/perfectbeauty/youcam/terms-of-service). And If you have any issue, please contact: [YouCamOnlineEditor_API@perfectcorp.com](mailto:YouCamOnlineEditor_API@perfectcorp.com)\n\n\n![YouCam Online Editor AI APIs](https://bcw-media.s3.ap-northeast-1.amazonaws.com/strapi/assets/YCO_AI_API.png \"YouCam Online Editor AI APIs\")\n\n## Introduction\n[YouCam Online Editor](https://yce.perfectcorp.com/) is a powerful and easy-to-use AI platform that provides beautiful and true-to-life visual effects thanks to the latest AI technology. This API document will briefly introduce how to integrate these awesome AI effects into your business. YouCam Online Editor AI APIs are standard RESTful APIs to let you easily integrate to your website, e-commerce platforms, iOS/Android APP, applets, mini-programs, and more.\n\n![YouCam Online Editor AI APIs](https://d3anovxlgi5hpq.cloudfront.net/assets/images/aiApi/banner/yce-topbanner-dt.png \"YouCam Online Editor AI APIs\")\n\n## API Server\nThe YouCam Online Editor AI APIs are built on top of RESTful web APIs. The API server is the host of all APIs. Once you complete the authentication, you can start your AI tasks through the API Server.\n- ### YouCam Online Editor AI API server: \n https://yce-api-01.perfectcorp.com\n\n## Rate Limit\nTo ensure fair usage and prevent abuse, our API implements rate limiting. There are two types of rate limits:\n\n- ### Per IP Address \n Each IP address is allowed a maximum of 250 requests per 300 seconds with 5 queries per second(QPS). If this limit is exceeded, subsequent requests will receive a `429 Too Many Requests` error.\n\n- ### Per Access Token\n Each access token is allowed a maximum of 250 requests per 300 seconds with 5 queries per second(QPS). If this limit is exceeded, subsequent requests will receive a `429 Too Many Requests` error.\n\nBoth conditions must be met for a request to be accepted. If either condition is not met, the request will receive a `429 Too Many Requests` error. Please note that each query related to unit will be processed real-time. Other APIs can use the access token util expired.\n\nIt is recommended that you handle rate limit errors gracefully in your application by implementing the appropriate backoff and retry mechanisms.\n\n\n## File Retention Period\nAny files you upload are stored on our server for one day, and then they're automatically deleted. Files created by the system \u2013 the results you get \u2013 we keep those for 30 days before they're automatically removed. \n\n> **Warning:** Even though those result files are still good for 30 days, the link to download them might only be active for about two hours after they're created. If that download link expires, you can still access the file using its file ID \u2013 you can use that ID with another feature to get it.\n\n\n## Supported Formats & Dimensions\n|AI Photo Editing|Supported Dimensions|Supported File Size|Supported Formats|\n| ---- | ---- | ---- | ---- |\n|AI Photo Enhance|Input: long side <= 4096, Output: long side <= 4096|< 10MB|jpg/jpeg/png|\n|AI Photo Colorize|Input: long side <= 4096, Output: long side <= 4096|< 10MB|jpg/jpeg/png|\n|AI Photo Color Correction|Input: long side <= 4096, Output: long side <= 4096|< 10MB|jpg/jpeg/png|\n|AI Photo Lighting|4096x4096 (long side <= 4096, short side >= 256)|< 10MB|jpg/jpeg/png|\n|AI Image Extender|Input: long side <= 4096, Output: short side <= 1024, long side <= 2048|< 10MB|jpg/jpeg/png|\n|AI Replace|Input: long side <= 4096, Output: short side <= 1024, long side <= 2048|< 10MB|jpg/jpeg/png|\n|AI Object Removal|Input: long side <= 4096, Output: long side <= 4096|< 10MB|jpg/jpeg/png|\n|AI Image Generator|Input: long side <= 4096, Output: long side <= 1024|< 10MB|jpg/jpeg/png|\n|Al Photo Background Removal|Input: long side <= 4096, Output: long side <= 4096|< 10MB|jpg/jpeg/png|\n|AI Photo Background Blur|Input: long side <= 4096, Output: long side <= 4096|< 10MB|jpg/jpeg/png|\n|AI Photo Background Change|Input: long side <= 4096, Output: long side <= 4096|< 10MB|jpg/jpeg/png|\n\n|AI Portrait|Supported Dimensions|Supported File Size|Supported Formats|\n| ---- | ---- | ---- | ---- |\n|AI Avatar Generator|Input: long side <= 4096, Output: long side <= 1024|< 10MB|jpg/jpeg/png|\n|AI Face Swap|4096x4096 (long side <= 4096), single face only, need to show full face|< 10MB|jpg/jpeg/png|\n\n|AI Video Editing|Supported Dimensions|Supported File Size|Supported Formats|\n| ---- | ---- | ---- | ---- |\n|AI Video Enhance|input: long side <= 1920; output: max 2x input resolution, up to 60 sec, 30 FPS, 8 bit|<100MB|container: mov, mp4; video codec: MPEG-4, H.264 AVC; audio codec: aac, mp3;|\n|AI Video Face Swap|input: long side <= 4096; output: 1280x720, 30 FPS, up to 30 sec, 8 bit, single face only|<100MB|container: mov, mp4; video codec: MPEG-4, H.264 AVC; audio codec: aac, mp3|\n|AI Video Style Transfer|input: long side <= 4096; output: long side <= 1280, 16 FPS, up to 30 sec, 8 bit|<100MB|container: mov, mp4; video codec: MPEG-4, H.264 AVC; audio codec: aac, mp3|\n\n## Error Codes\n- Successful responses (100 - 399)\n- Client error responses (400 - 499)\n- Server error response (500 - 599)\n\n| General Error Code | Description |\n| ------------------ | ----------- |\n| exceed_max_filesize | The input file size exceeds the maximum limit |\n| invalid_parameter | The parameter value is invalid |\n| error_download_image | There was an error downloading the source image |\n| error_download_mask | There was an error downloading the mask image |\n| error_decode_image | There was an error decoding the source image |\n| error_decode_mask | There was an error decoding the mask image |\n| error_download_video | There was an error downloading the source video |\n| error_decode_video | There was an error decoding the source video |\n| error_nsfw_content_detected | NSFW content was detected in the source image |\n| error_no_face | No face was detected in the source image |\n| error_pose | Failed to detect pose in the source image |\n| error_face_parsing | Failed to perform face parsing on the source image |\n| error_inference | An error occurred in the inference pipeline |\n| exceed_nsfw_retry_limits | Retry limits exceeded to avoid generating NSFW image |\n| error_upload | There was an error uploading the result image |\n| error_multiple_people | Multiple people were detected in the source image |\n| error_no_shoulder | Shoulders are not visible in the source image |\n| error_large_face_angle | The face angle in the uploaded image is too large |\n| error_hair_too_short | The input hair is too short |\n| error_unexpected_video_duration | The video duration does not match the expected duration |\n| error_bald_image | The input hairstyle is bald |\n| error_unsupport_ratio | The aspect ratio of the input image is unsupported |\n| unknown_internal_error | Other internal errors |\n\n---\n\n# Quick Start Guide\nFirst, you need to register a YouCam Online Editor account for free at [https://yce.perfectcorp.com/](https://yce.perfectcorp.com/). You can then purchase or subscribe to get your units to use the service. You can see your subscription plan, pay as you go units, and your usage record at [https://yce.perfectcorp.com/api-console/en/api-keys/](https://yce.perfectcorp.com/api-console/en/api-keys/). You can go to the API Key tab under your account page to generate and maintain your API keys to start using the YouCam Online Editor AI APIs.\n\n\n## V2 API\n\n### **Overview**\nStarting from **API version v1.5**, we have introduced a **simplified V2 API** to streamline integration processes.\n\n**Scope:**\n- AI Skin Analysis\n- AI Hair Color\n- AI Hairstyle Generator\n- AI Clothing\n> **Note:** V2 API is designed for workflow simplification only. It does not introduce advanced functionality. Both V1 APIs and V2 APIs use the same underlying AI models.\n\n---\n\n### **Key Changes in V2 API**\n\n#### **1. Endpoint Reduction**\n- **V1 API Endpoints:**\n - `POST /v1.0/client/auth` \u2013 Authentication\n - `POST /v1.1/file/ai-task` \u2013 Upload a file\n - `POST /v1.0/task/ai-task` \u2013 Run an AI task\n - `GET /v1.0/task/ai-task` \u2013 Get the result\n\n- **V2 API Endpoints:**\n - `POST /v2.0/file/ai-task` \u2013 Upload a file or provide a file URL\n - `POST /v2.0/task/ai-task` \u2013 Run an AI task\n - `GET /v2.0/task/ai-task` \u2013 Get the result\n\n#### **2. Authentication**\n- **V1 API:** Requires explicit call to Authentication endpoint.- **V2 API:** No separate authentication endpoint. - Include your API key in the request header using **Bearer Token**:\n ```\n Authorization: Bearer \n ```\nYou can find your API Key at https://yce.perfectcorp.com/api-console/en/api-keys/.\n\n#### **3. Image Input**\n- Supports **both file upload and file URL** as input sources.\n\n#### **4. Polling Mechanism**\n- Processed results are retained for **24 hours** after completion.- No need for short-interval polling.- Flexible polling intervals within the 24-hour window.- **Important:** Polling is still required to check task status, as execution time is not guaranteed.\n\n#### **5. JSON Structure Simplification**\n- **List Style API** now uses a simplified JSON parameter structure.\n - AI Hairstyle Generator: https://yce-api-01.perfectcorp.com/s2s/v2.0/task/template/hair-style\n - AI Clothes: https://yce-api-01.perfectcorp.com/s2s/v2.0/task/template/cloth\n\n---\n\n### **Summary**\n- **V2 API = Simplified workflow, same AI models.**- Reduced endpoints, easier authentication, flexible input options, improved polling, and cleaner JSON.\n\n---\n\n## V1 API\nTo complete the authentication and start using the AI APIs, you need:\n1. Go to https://yce.perfectcorp.com/api-console/en/api-keys/ and create the API Key.\n\n1. Upon creation is completed, it will show the API Key and the Secret key. Where your API Key is the ***client_id*** and the Secret key is the ***client_secret*** in this document to complete the authentication process.\n\n

\n\n > **Warning:** Please kindly note that your Secret key can only be copied at step #2. Once the dialog is closed, there is no method to obtain the Secret key again unless create an another API Key.\n\n1. To obtain id_token, you need to follow the method below and convert client_secret into id_token\n\n Encrypt\n > **client_id=\\×tamp=\\**\n\n with RSA X.509 format Base64 encoded client_secret to obtain id_token\n\n JavaScript sample:\n ```javascript\n let encrypt = new JSEncrypt();\n encrypt.setPublicKey(client_secret);\n let encrypted = encrypt.encrypt(\n `client_id=${client_id}×tamp=${new Date().getTime()}`\n );\n console.log(encrypted);\n ```\n\n PHP sample:\n ```php\n publicKey = openssl_pkey_get_public($pemKey);\n if ($this->publicKey === false) {\n throw new Exception('Invalid public key');\n }\n }\n\n public function encrypt($data) {\n $encrypted = '';\n $result = openssl_public_encrypt($data, $encrypted, $this->publicKey);\n if ($result === false) {\n throw new Exception('Encryption failed');\n }\n return base64_encode($encrypted);\n }\n }\n\n try {\n $rawPublicKey = \"\";\n\n $rsa = new RSAPublicEncryption($rawPublicKey);\n\n $data = \"client_id=×tamp=\";\n\n $encrypted = $rsa->encrypt($data);\n echo \"Encrypted: \" . $encrypted . \"\\n\";\n\n } catch (Exception $e) {\n echo \"Error: \" . $e->getMessage();\n }\n ?>\n ```\n\n1. Calling the authentication API to obtain the ***access_token*** to start using the YouCam Online Editor AI APIs.\n\nPlease note that your units will be consumed when the resulting image was successfully generated. You may refer to [the AI API page](https://yce.perfectcorp.com/ai-api) regarding the price of each task and how to obtain units.\n\n---\n### V1 API AI Task Execution Workflow and Style Querying APIs\nWe support three categories of AI tasks:\n\n- **Direct Execution Tasks**
\nThese tasks operate directly on user input without additional configuration. Examples include AI Photo Enhance and AI Image Extender.\n\n- **Style-Based Tasks**
\nThese require an initial style selection before execution. Examples include AI Hairstyles Try-On, AI Studio Generator, and AI Clothes Try-On.
\n There are two ways to retrieve styles for these tasks:\n - Version 1.0\n - v1.0/task/style-group/{feature}: Lists style groups.\n - v1.0/task/style/{feature}: Fetches styles within the selected group.\n - Version 1.1\n - v1.1/task/style/{feature}: Retrieves styles categorized by predefined groups. If no category_id is specified, the response includes either styles or subcategories. Single-layer categories contain only styles, while multi-layer categories include subcategories. To explore a subcategory, provide its ID as category_id and query the endpoint again.\n\n- **Preprocessing-Required Tasks**
\nThese tasks require an initial detection step before execution. For example, AI Face Swap needs a face detection task to identify faces in the input. After detection, you can specify which face to swap in the main AI task.\n\n---\n### V1 API Integration Guide - Direct Execution Tasks\nNow, let's consider an example usage flow of an ***AI Photo Enhance*** API calling sequence.\n\n1. **Upload file using the File API**
\nAfter successfully authorizing and getting the access_token, you can call 'file/enhance' to acquire the upload URL and a File ID associated with it.\nIt will give you a URL \u2013 use that URL to upload your file. Once the upload is finished, you can use the file_id from the same response to start using our AI features.\n\n2. **Run an AI task to obtain it's task_id**
\nSubsequently, calling POST 'task/enhance' with the \nFile ID executes the enhance task and obtains a ***task_id***.\n\n3. **Polling to check the status of a task until it succeed or error**
\nThis ***task_id*** is used to monitor the task's status through polling GET 'task/enhance' to retrieve the current engine status. Until the engine completes the task, the status will remain 'running', and no units will be consumed during this stage.\n\n **Warning:** Please note that, **Polling** to check the status of a task based on it's ***polling_interval*** is mandotary. A task will be timed out if there is no polling request within the ***polling_interval***, even if the task is processed succefully(Your unit(s) will be consumed).\n\n > **Warning:** You will get a ***InvalidTaskId*** error once you check the status of a timed out task. So, once you run an AI task, you need to **polling** to check the status within the ***polling_interval*** until the status become either *success* or *error*.\n\n4. **Get the result of an AI task once success**
\nThe task will change to the 'success' status after the engine successfully processes your input file and generates the resulting image. You will get an url of the processed image and a dst_id that allow you to chain another AI task without re-upload the result image.\nYour units will only be consumed in this case. If the engine fails to process the task, the task's status will change to 'error' and no unit will be consumed.
\nWhen deducting units, the system will prioritize those nearing expiration. If the expiration date is the same, it will deduct the units obtained on the earliest date.\n\n### V1 API Integration Guide - Style-Based Tasks\nNow, let's consider an example usage flow of an ***AI Clothes*** API calling sequence to try on predefined outfit styles.\n\n1. **Upload file using the File API**
\n Using the ***v1.1/file/cloth*** API to upload a target user image.\n - Image Requirements\n - See details in **[File Specs & Errors](#tag/AI-Clothes/File-Specs-and-Errors)**.\n - Upload a full body photo of yourself. The virtual outfit changer works best with high resolution photos that show your clothes clearly. The photo background should not have too many people or distracting objects.\n\n2. **List Predefined Outfit Styles**
\n There are two ways to list outfits for AI Clothes virtual try-on:\n - ***v1.0/task/style-group/cloth*** and ***v1.0/task/style/cloth***: Retrieve style groups first, then fetch styles within the chosen group.\n - ***v1.1/task/style/cloth***: Fetch a predefined style list by category. If you don\u2019t specify a category_id, each category will contain either styles or subcategories. Categories with a single layer only include styles, while multi-layered categories will have subcategories. To explore a subcategory, pass its ID as category_id and call the list again.\n\n3. **Run an AI task to obtain it's task_id**
\n Execute AI task ***v1.0/task/cloth*** with the clothing image file_id as ref_ids and the target user image file_id as src_ids.\n\n4. **Polling to check the status of a task until it succeed or error**
\n This ***task_id*** is used to monitor the task's status through polling GET 'v1.0/task/cloth' to retrieve the current engine status. Until the engine completes the task, the status will remain 'running', and no units will be consumed during this stage.\n\n **Warning:** Please note that, **Polling** to check the status of a task based on it's ***polling_interval*** is mandotary. A task will be timed out if there is no polling request within the ***polling_interval***, even if the task is processed succefully(Your unit(s) will be consumed).\n\n > **Warning:** You will get a ***InvalidTaskId*** error once you check the status of a timed out task. So, once you run an AI task, you need to **polling** to check the status within the ***polling_interval*** until the status become either *success* or *error*.\n\n5. **Get the result of an AI task once success**
\n The task will change to the 'success' status after the engine successfully processes your input file and generates the resulting image. You will get an url of the processed image and a dst_id that allow you to chain another AI task without re-upload the result image.
Your units will only be consumed in this case. If the engine fails to process the task, the task's status will change to 'error' and no unit will be consumed.
When deducting units, the system will prioritize those nearing expiration. If the expiration date is the same, it will deduct the units obtained on the earliest date.\n\n---\n# FAQ\n## Q&A Hub\n1. **Q: What does 'Unit' mean, and how is it used?**\n
**A:** Please note that credits are exclusively used within the YouCam Online Editor UI, whereas units are designated solely for AI API usage. Throughout this document, all references to 'credit' or 'unit' pertain to the Unit.\n
\n Please check the page https://yce.perfectcorp.com/ai-api for details on how many units each AI feature consumes.\n

\n\n1. **Q: Why am I getting InvalidTaskId error?**\n
**A:** You will get a ***InvalidTaskId*** error once you check the status of a timed out task. So, once you run an AI task, you need to **polling** to check the status within the ***polling_interval*** until the status become either *success* or *error*.\n

\n\n1. **Q: What is client_id, client_secret and id_token?**\n
**A:** Your API Key is the ***client_id*** and the Secret key is the ***client_secret***. And please follow the Quick start guide to get the ***id_token*** to complete the authentication process.\n\n For more information and questions, please refer to our [blog page](https://www.perfectcorp.com/consumer/blog) and the [FAQ page](https://yce.perfectcorp.com/faq). Or send an e-mail to [YouCamOnlineEditor_API@perfectcorp.com](mailto:YouCamOnlineEditor_API@perfectcorp.com). Our customer success team are very happy to help. ;)\n

\n\n1. **Q: How to uplaod an image through curl?**\n
**A:** curl --location --request PUT '{url_api_response}' --header '{headers_in_api_response}' --data-binary @'{local_file_path}'\n ```\n curl --location --request PUT 'https://yce-us.s3-accelerate.amazonaws.com/ttl30/320554715144259928/77022501909/v2/aeMNNB0KmUIP8rnQ996tC5Q/49c9f5cb-882c-41d9-a435-73b951cdf018.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20250507T110821Z&X-Amz-SignedHeaders=content-length%3Bcontent-type%3Bhost&X-Amz-Expires=7200&X-Amz-Credential=AKIARB77EV5Y5D7DAE3S%2F20250507%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=efaeed8fd3da03be0f0c9ed1274325651ef2adffb51321cc489f6baa4a80e394' --header 'Content-Type: image/jpg' --header 'Content-Length: 50000' \u00a0--data-binary @'./test.jpg'\n ```\n

\n\n1. **Q: What platforms does the AI API support? Can it be used on mobile devices?**\n
**A:** The AI API works seamlessly across different platforms. Since it's built on a standard RESTful API, you can use it for server-to-server communication, on mobile devices, or in a web browser - whatever best fits your needs.\n

\n\n1. **Q: Is it possible to use the AI API with Flutter on both Android and iOS?**\n
**A:**\n Absolutely. Since AI APIs are standard RESTful APIs, you can access them using Flutter's built-in HTTP APIs to make requests.\n\n Here are some official Flutter documents on making network queries.\n * https://docs.flutter.dev/cookbook/networking/fetch-data\n * https://pub.dev/packages/http\n\n And here\u2019s a simple way to call a http GET with Bearer Authentication using Flutter\u2019s http package:\n ```dart\n import 'dart:convert';\n import 'package:http/http.dart' as http;\n\n Future fetchData() async {\n String token = \"your_bearer_token_here\"; // Replace with your actual token\n\n final response = await http.get(\n Uri.parse(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/ai-task\"),\n headers: {\n \"Content-Type\": \"application/json\",\n \"Authorization\": \"Bearer $token\",\n },\n );\n\n if (response.statusCode == 200) {\n print(\"Data fetched successfully: ${response.body}\");\n } else {\n print(\"Failed to fetch data: ${response.statusCode}\");\n }\n }\n ```\n Key Steps to Auth:\n - Retrieve the Token \u2013 You can store and retrieve the token using SharedPreferences or another secure storage method.\n - Include the Token in Headers \u2013 Use \"Authorization\": \"Bearer $token\" in the request headers.\n - Handle Expired Tokens \u2013 If the API returns a 401 InvalidAccessToken error, refresh the token if needed.\n

\n\n1. **Q: API key is the API key, Where can I find the secret key?**\n
**A:** The secret key is created only when you first generate it. So make sure to save it right away, you won't be able to see it again later.\n

\n\n1. **Q: Is it possible to integrate AI APIs into your website using Wix?**\n
**A:** We do not currently have an official integration guide for using AI APIs with Wix. However, the RESTful API itself does not impose any restrictions on the platform, provided it supports standard web queries.\n\n We strongly recommend to begin by reading the official documentation provided by Wix: https://dev.wix.com/docs/develop-websites/articles/get-started/integrate-with-3rd-parties\n\n Wix offers several methods for integrating with third-party APIs, primarily through its Velo development platform:\n\n * Fetch API:\n This is the most common method and an implementation of the standard JavaScript Fetch API. It allows you to make HTTP requests to external APIs from your Wix site's frontend or backend code.\n Backend calls: Recommended for security (especially for APIs requiring keys) and to avoid CORS issues. Use the Secrets Manager to securely store API keys.\n Frontend calls: Possible but less secure and may encounter CORS restrictions.\n\n * npm Packages:\n Velo supports the use of approved npm packages, allowing you to leverage a wide array of prebuilt JavaScript modules to extend your site's functionality with third-party features.\n\n * Service Plugins (formerly SPIs/Custom Extensions):\n These enable you to inject custom logic or integrate third-party services directly into Wix's business solutions (e.g., Wix Stores, Wix Bookings). Service plugins allow you to customize specific parts of existing app flows or integrate external services for functionalities like custom shipping rates, dynamic pricing, or alternative payment providers.\n\n * HTTP Functions:\n You can expose your site's functionality as an API, allowing third-party services to call your Wix site''s backend functions and interact with your site's data or logic.\n\n Steps for Integration (using Fetch API as an example):\n\n * Store API Keys: If the third-party API requires authentication, store sensitive credentials like API keys securely in Wix's Secrets Manager.\n Import wix-fetch: In your Velo backend or frontend code, import the wixFetch module.\n\n ```JavaScript\n import { fetch } from 'wix-fetch';\n ```\n\n * Make API Calls: Use the fetch function to send requests to the third-party API, including necessary headers and body data.\n\n ```JavaScript\n export async function getWeatherData() {\n const apiKey = await getSecret(\"yourApiKeyName\"); // Retrieve from Secrets Manager\n const response = await fetch(`https://api.weatherapi.com/v1/current.json?key=${apiKey}&q=London`, {\n method: 'GET',\n headers: {\n 'Content-Type': 'application/json'\n }\n });\n const data = await response.json();\n return data;\n }\n ```\n\n * Handle Responses: Process the data received from the API and integrate it into your site's design or functionality.\n

\n\n1. **Q: Is it possible to integrate AI APIs into WooCommerce?**\n
**A:** We do not currently have an official integration guide for using AI APIs with WooCommerce. However, the RESTful API itself does not impose any restrictions on the platform, provided it supports standard web queries.\n\n We strongly recommend to begin by reading the official documentation provided by WooCommerce: https://woocommerce.com/document/woocommerce-rest-api/\n\n Integrating third-party APIs with WooCommerce enhances store functionality and streamlines operations. This can be achieved through various methods:\n\n * Utilizing WooCommerce REST API:\n\n WooCommerce provides a robust REST API that allows external applications to interact with your store data.\n You can create API keys with specific permissions (Read, Write, or Read/Write) in WooCommerce > Settings > Advanced > REST API.\n This enables you to automate tasks like inventory syncing, order processing, customer data synchronization, and more, by building custom integrations or using third-party services that leverage this API.\n\n * Employing Plugins:\n\n Many WordPress and WooCommerce plugins are designed specifically for integrating with popular third-party services like payment gateways, shipping carriers, CRM systems, and accounting software.\n Plugins often offer pre-built integrations, simplifying the setup process and reducing the need for custom coding.\n Examples include plugins for specific payment processors (e.g., Stripe, PayPal), shipping solutions (e.g., FedEx, USPS), or general API integration tools like WPGet API.\n\n * Custom Code and Webhooks:\n\n For unique integration needs or when a suitable plugin isn't available, you can implement custom code within your WordPress theme or a custom plugin.\n This involves using WordPress/WooCommerce hooks and filters to trigger API calls at specific events (e.g., woocommerce_payment_complete for post-purchase actions).\n Webhooks can also be used to send real-time data from WooCommerce to a third-party service when certain events occur (e.g., new order, product update).\n

\n\n## Debugging Guide\n1. **Invalid TaskId Error**\n
**Why:** You\u2019ll receive an InvalidTaskId error if you attempt to check the status of a task that has timed out. Therefore, once an AI task is initiated, you\u2019ll need to poll for its status within the polling_interval until the status changes to either success or error.\n
**Solution:** To avoid the task becoming invalid, it\u2019s necessary to implement a timed loop that queries the task status at regular intervals within the allowed polling window.\n\n1. **500 Server Error / unknown_internal_error**\n
**A:** ***Important***: Simply calling the File API does not upload your file. You must manually upload the file to the URL provided in the File API response. That URL is your upload destination, make sure the file is successfully transferred there before proceeding.
\n Before calling the AI API, ensure your file has been successfully uploaded. Use the File API to retrieve an upload URL, then upload your file to that location. Once the upload is complete, you'll receive a ***file_id*** in the response, this ID is what you'll use to access AI features related to that file.\n

\n\n1. **404 Not Found error when using AI APIs**\n
**A:** ***Important***: Simply calling the File API does not upload your file. You must manually upload the file to the URL provided in the File API response. That URL is your upload destination, make sure the file is successfully transferred there before proceeding.
\n Before calling the AI API, ensure your file has been successfully uploaded. Use the File API to retrieve an upload URL, then upload your file to that location. Once the upload is complete, you'll receive a ***file_id*** in the response, this ID is what you'll use to access AI features related to that file.\n

\n\n1. **The API response returns the same style ID on the Postman**\n
**A:** The is because Postman (Pretty view) and Chrome use JavaScript to parse JSON responses. In JavaScript, numbers larger than 9007199254740991 (2^53-1) cannot be represented precisely. They are rounded to the nearest representable value, which makes different IDs appear identical (e.g., 219691778809271815 \u2192 219691778809271800).
\n * Precision Loss in JavaScript/JSON Error Handling\n * Cause: JavaScript's Number type cannot safely handle integers beyond 2^53 - 1, leading to silent truncation or rounding.\n * Solution: Use a JSON parser like ***json-bigint*** to treat IDs as strings and retain full precision.\n

\n" }, "servers": [ { "url": "https://yce-api-01.perfectcorp.com" } ], "tags": [ { "name": "Authentication", "description": "Authentication with Perfect API server." }, { "name": "Unit system", "description": "Check your unit details and usage history. Please note that credits are exclusively used within the YouCam Online Editor UI, whereas units are designated solely for AI API usage. Throughout this document, all references to 'credit' or 'unit' pertain to the Unit." }, { "name": "AI Photo Enhance", "description": "### AI Photo Enhance\nAI Photo Enhancer uses advanced AI and deep learning to analyze image details and improve resolution, making low-resolution images clear & fix motion blur.\n * No More Pixelation: Eliminate pixelation for smoother, more defined images.\n * Fix Blurry Photos: Remove blurriness to reveal sharper, crisper details.\n * Enhance Quality: Bring out finer details, making every part of your image stand out.\n * Sharpen Images: Increase sharpness for clearer and more vivid images.\n * Improve Clarity: Boost overall clarity to make your photos look fresh and professional.\n * Face Enhancement: Refine facial features for more lifelike, enhanced portraits in motional images.\n\nBefore sample:\n![AI Photo Enhance](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_s5_poster_1_0779bbdbdb.jpg \"AI Photo Enhance\")\n\nAfter sample:\n![AI Photo Enhance](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_s5_poster_2_a2e15250ef.jpg \"AI Photo Enhance\")\n\n\nBefore sample:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_s2_poster_1_4cd6425807.jpg)\n\nAfter sample:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_s2_poster_2_7674281362.jpg)" }, { "name": "AI Object Removal", "description": "### AI Object Removal\nRemove unwanted objects with precision from your photos while preserving intricate details.\nTo use this amazing feature, simply input a photo along with a grayscale mask where white pixels indicate foreground elements and black pixels represent background areas. The AI Object Removal then leverages advanced algorithms to produce natural-looking images by effectively removing unwanted objects such as people, reflections, shadows, and other distractions from your photos.\n\nSample input:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_removal_s4_poster_1_594c5b12a3.jpg)\n\nSample output:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_removal_s4_poster_2_4a858c74b7.jpg)\n\nSample input:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_removal_s3_poster_1_f7a922c2fd.jpg)\n\nSample output:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_removal_s3_poster_2_8894e78c01.jpg)\n" }, { "name": "AI Photo Background Removal", "description": "### AI Photo Background Removal\nRemove background from photo with impeccable accuracy, ensuring the high quality of images.\n* Automatic Background Detection: : Uses AI to identify and separate the subject from the background.\n* High Precision Editing: : Provides clean and precise edges around the subject.\n* Supports various categories: People, Products, Animals, Cars, Graphics & more.\n* Easy to chain with other AI tasks: The output file ID can be chained into other AI tasks in a flash.\n\n![](https://plugins-media.makeupar.com/smb/blog/post/2023-11-03/54285311-7c65-4658-9e27-11bf5c8dfe56.jpg)\n\n## Integration Guide\n### How to run AI Photo Background Removal\n1. **Resize your source image**
\n Resize your photo to fit the supported dimensions. See details in **[File Specs & Errors](#tag/AI-Photo-Background-Removal/File-Specs-and-Errors)**\n\n2. **Upload file using the File API**
\n Using the ***v1.1/file/sod*** API to upload a target user image.\n - Image Requirements\n - See details in **[File Specs & Errors](#tag/AI-Photo-Background-Removal/File-Specs-and-Errors)**.\n - ***Important***: Simply calling the File API does not upload your file. You must **manually upload** the file to the **URL provided in the File API response**. That URL is your upload destination, make sure the file is successfully transferred there before proceeding.
\n Before calling the AI API, ensure your file has been successfully uploaded. Use the File API to retrieve an upload URL, then upload your file to that location. Once the upload is complete, you'll receive a ***file_id*** in the response, this ID is what you'll use to access AI features related to that file.\n \n > **Warning:** Please note that, you will get an 500 Server Error / unknown_internal_error or 404 Not Found error when using AI APIs if you do not upload the file to the URL provided in the File API response.\n\n3. **Run an AI task**
\n Once the upload is complete, calling POST 'task/sod' with the File ID to execute the AI task and obtains a ***task_id*** to monitor.\n\n4. **Polling to check the status of a task until it succeed or error**
\nThis ***task_id*** is used to monitor the task's status through polling GET 'task/sod' to retrieve the current engine status. Until the engine completes the task, the status will remain 'running', and no units will be consumed during this stage.\n\n **Warning:** Please note that, **Polling** to check the status of a task based on it's ***polling_interval*** is mandotary. A task will be timed out if there is no polling request within the ***polling_interval***, even if the task is processed succefully(Your unit(s) will be consumed).\n\n > **Warning:** You will get a ***InvalidTaskId*** error once you check the status of a timed out task. So, once you run an AI task, you need to **polling** to check the status within the ***polling_interval*** until the status become either *success* or *error*.\n\n5. **Get the result of an AI task once success**
\nThe task will change to the 'success' status after the engine successfully processes your input file and generates the resulting image. You will get an url of the processed image and a dst_id that allow you to chain another AI task without re-upload the result image.\nYour units will only be consumed in this case. If the engine fails to process the task, the task's status will change to 'error' and no unit will be consumed.
\nWhen deducting units, the system will prioritize those nearing expiration. If the expiration date is the same, it will deduct the units obtained on the earliest date.\n\n### Demonstrative scenarios:\nCommon implementation cases:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/Transparen_Background_aca3cdbd83.jpg)\n\n## Inputs & Outputs\n### Inputs\n#### `Image`\n- **Type:** `image`\n- **Description:** An image with clear foreground.\n\nReal-world application (input): \n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_removal_bg_s4_poster_1_289b8eaf81.png)\n\n---\n\n### Outputs\n#### `Foreground image`\n- **Type:** `image`\n- **Description:** A background removed image.\n\nReal-world application (output):\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_removal_bg_s4_poster_2_a6bc3c5f6a.png)\n\n## File Specs & Errors\n### Supported Formats & Dimensions\n|AI Feature|Supported Dimensions|File Size|Accepted formats|\n| ---- | ---- | ---- | ---- |\n|AI Photo Background Removal|Recommendations and limitations for both input and output images are as follows:
Resolution: 4096 \u00d7 4096 pixels (longest side must not exceed 4096 pixels)|<10MB|JPG and PNG|\n\n### Error Codes\n|Error Code|Description|\n| ---- | ---- |\n|exceed_max_filesize|Input file size exceeds the maximum limit|\n|invalid_parameter|Invalid parameter value|\n|error_download_image|Download source image error|\n|error_download_mask|Download mask image error|\n|error_decode_image|Decode source image error|\n|error_decode_mask|Decode mask image error|\n|error_download_video|Download source video error|\n|error_decode_video|Decode source video error|\n|error_nsfw_content_detected|NSFW content detected in source image|\n|error_no_face|No face detected on source image|\n|error_pose|Failed to detect pose on source image|\n|error_face_parsing|Failed to do face segmentation on source image|\n|error_inference|Inference pipeline error|\n|exceed_nsfw_retry_limits|Exceed the retry limits to avoid generated NSFW image|\n|error_upload|Upload result image error|\n|error_multiple_people|Multiple people detected in the source image|\n|error_no_shoulder|Shoulders are not visible in the source image|\n|error_large_face_angle|The face angle in the uploaded image is too large|\n|error_hair_too_short|Input hair is too short|\n|error_unexpected_video_duration|Video durateion is not equal to the dstDuration|\n|error_bald_image|Input hairstyle is bald|\n|error_unsupport_ratio|The aspect ratio of input image is unsupported|\n|unknown_internal_error|Others|\n" }, { "name": "AI Photo Background Change", "description": "### AI Photo Background Change\nThe AI Photo Background Change tool enhances photos by effortlessly isolating the subject from the background image, allowing for various application, including in business, to sharpen the focus on product subjects.\n\nBy using this API, you can easily extract a foreground mask from a input image. So that you can change the background using the mask by any other images or colors.\n\nSample\nBefore:\n![](https://yce.perfectcorp.com/assets/images/sod/banner/change/yce-topbanner-dt-before.jpg)\n\nAfter:\n![](https://yce.perfectcorp.com/assets/images/sod/banner/change/yce-topbanner-dt-after.jpg)\n\n\nBefore:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_change_bg_s5_poster_before_0753db3e02.jpg)\n\nAfter:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_change_bg_s5_poster_after_7fb288fde2.jpg)" }, { "name": "AI Photo Background Blur", "description": "### AI Photo Background Blur\nThe AI Photo Background Blur tool enhances photos by effortlessly isolating the subject from the background image, allowing for various application, including in bokeh simulation, to sharpen the focus on product subjects.\n\nBy using this API, you can easily extract a foreground mask from a input image. So that you can blur the background using the mask by any image blur algorithms like the gaussian blur or custom blur kernels.\n\nSample\nBefore:\n![](https://yce.perfectcorp.com/assets/images/sod/banner/blur/yce-topbanner-dt-before.jpg)\n\nAfter:\n![](https://yce.perfectcorp.com/assets/images/sod/banner/blur/yce-topbanner-dt-after.jpg)\n\n\nBefore:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_blur_bg_s3_poster_1_50a314e3f9.jpg)\n\nAfter:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_blur_bg_s3_poster_2_afb0548cb7.jpg)\n" }, { "name": "AI Photo Colorize", "description": "### AI Photo Colorize\nUsing the latest AI technology to colorize black and white photos, old images, or repair them. With AI Photo Colorize, you can instantly generate 4 different colorized versions of your photos, each with unique color tones ranging from warm to cool. Utilizing deep learning technology, this tool transforms your black and white photos into vibrant color images within seconds.\n\n![AI Photo Colorize](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_colorize_s4_poster_11c0bdfead.jpg \"AI Photo Colorize\")" }, { "name": "AI Image Generator", "description": "### AI Image Generator\nDiscover the power of AI with our innovative text-to-image generator! Transform your ideas into stunning visuals instantly, experiment with prompts, explore unique styles like cartoons, oil paintings, or sketches, and let your creativity shine through. Whether you're an artist, designer, or creative soul, our tool offers endless possibilities to bring your vision to life. Add images as references to inspire new artistic directions while letting AI refine them into entirely original masterpieces.\n\nWant more inspirations? Please refer to https://yce.perfectcorp.com/ai-art-generator.\n\nUse cases:\n![AI Image Generator](https://bcw-media.s3.ap-northeast-1.amazonaws.com/text_to_image_v3_video_02f161f909.jpg \"AI Image Generator\")\n\n![AI Image Generator](https://bcw-media.s3.ap-northeast-1.amazonaws.com/text_to_image_v4_poster_092d2fbb9f.jpg \"AI Image Generator\")\n\nSample output:\n![AI Image Generator](https://bcw-media.s3.ap-northeast-1.amazonaws.com/text_to_image_topbanner_dt_2_e325681588.jpg \"AI Image Generator\")\n\n![AI Image Generator](https://bcw-media.s3.ap-northeast-1.amazonaws.com/text_to_image_topbanner_dt_5_8b4fa13c6a.jpg \"AI Image Generator\")" }, { "name": "AI Hairstyle Generator V1", "description": "### AI Hairstyle Generator\nUsing the latest AI technology to try a wide variety of hairstyles, catering to both women and men, meeting different gender and style preference.\nDiscover a world of styles: curly, long, buzz cut, and more. Our AI-powered hair changer lets you experiment effortlessly. Find your ideal hairstyle now!\n\nWant to see more Hair styles? Please refer to https://yce.perfectcorp.com/ai-hairstyle-generator.\n\nUse case:\n![AI Hairstyle Generator](https://bcw-media.s3.ap-northeast-1.amazonaws.com/hair_style_v1_video_08513beb46.jpg\n \"AI Hairstyle Generator\")\n\n![AI Hairstyle Generator](https://bcw-media.s3.ap-northeast-1.amazonaws.com/hair_style_v3_poster_bb1c7aad10.jpg \"AI Hairstyle Generator\")\n\nSuggestions for How to Shoot:\n![Suggestions for How to Shoot](https://bcw-media.s3.ap-northeast-1.amazonaws.com/AI_Hair_Extension_recommendation_ba24bd5d92.png \"Suggestions for How to Shoot\")\n\n## File Specs & Errors\n### Supported Formats & Dimensions\n|AI Feature|Supported Dimensions|Supported File Size|Supported Formats|\n| ---- | ---- | ---- | ---- |\n|AI Hairstyle Generator|long side <= 1024, face width >= 128, face pose: -10 < pitch < +10, -45 < yaw < +45, -15 < roll < +15, single face only, need to show full face|< 10MB|jpg/jpeg|\n\n### Error Codes\n|Error Code|Description|\n| ---- | ---- |\n|error_no_shoulder\t|Shoulders are not visible in the source image\n|error_large_face_angle\t|The face angle in the uploaded image is too large\n|error_insufficient_landmarks\t|Cannot detect sufficient face or body landmarks in the source image\n|error_hair_too_short\t|Input hair is too short\n|error_face_pose\t|The face pose of source image is unsupported\n\n### Environment & Dependency\n| Sample Code Language / Tool | Recommended Runtime Versions |\n|---|---|\n| cURL | cURL 8.x |\n| Node.js (JavaScript) | Node.js 18.x/20.x LTS |\n| JavaScript | Compatible with Chromium v100 |\n| PHP | PHP 8.1+ |\n| Python | Python 3.10+ |\n| Java | JDK 1.8 or 21 LTS |\n\n## FAQ\n**Q: Can I try on a custom hairstyle?**\n\n**A:** It's a cool idea, but we're not able to support custom hairstyles right now. Right now, those custom hairdos need heavy optimization to look natural. But if you still want to personalize something, feel free to reach out to our customer success team at [YouCamOnlineEditor_API@perfectcorp.com](mailto:YouCamOnlineEditor_API@perfectcorp.com). Let us know what kind of hairstyles you're thinking of, feel free to send sample pics and tell us who you're trying to reach and how big your market is. Let's build something cool together.\n" }, { "name": "AI Hairstyle Generator", "description": "### AI Hairstyle Generator\nUsing the latest AI technology to try a wide variety of hairstyles, catering to both women and men, meeting different gender and style preference.\nDiscover a world of styles: curly, long, buzz cut, and more. Our AI-powered hair changer lets you experiment effortlessly. Find your ideal hairstyle now!\n\nWant to see more Hair styles? Please refer to https://yce.perfectcorp.com/ai-hairstyle-generator.\n\nUse case:\n![AI Hairstyle Generator](https://bcw-media.s3.ap-northeast-1.amazonaws.com/hair_style_v1_video_08513beb46.jpg\n \"AI Hairstyle Generator\")\n\n![AI Hairstyle Generator](https://bcw-media.s3.ap-northeast-1.amazonaws.com/hair_style_v3_poster_bb1c7aad10.jpg \"AI Hairstyle Generator\")\n\nSuggestions for How to Shoot:\n![Suggestions for How to Shoot](https://bcw-media.s3.ap-northeast-1.amazonaws.com/AI_Hair_Extension_recommendation_ba24bd5d92.png \"Suggestions for How to Shoot\")\n\n## File Specs & Errors\n### Supported Formats & Dimensions\n|AI Feature|Supported Dimensions|Supported File Size|Supported Formats|\n| ---- | ---- | ---- | ---- |\n|AI Hairstyle Generator|long side <= 1024, face width >= 128, face pose: -10 < pitch < +10, -45 < yaw < +45, -15 < roll < +15, single face only, need to show full face|< 10MB|jpg/jpeg|\n\n### Error Codes\n|Error Code|Description|\n| ---- | ---- |\n|error_no_shoulder\t|Shoulders are not visible in the source image\n|error_large_face_angle\t|The face angle in the uploaded image is too large\n|error_insufficient_landmarks\t|Cannot detect sufficient face or body landmarks in the source image\n|error_hair_too_short\t|Input hair is too short\n|error_face_pose\t|The face pose of source image is unsupported\n\n### Environment & Dependency\n| Sample Code Language / Tool | Recommended Runtime Versions |\n|---|---|\n| cURL | cURL 8.x |\n| Node.js (JavaScript) | Node.js 18.x/20.x LTS |\n| JavaScript | Compatible with Chromium v100 |\n| PHP | PHP 8.1+ |\n| Python | Python 3.10+ |\n| Java | JDK 1.8 or 21 LTS |\n\n## FAQ\n**Q: Can I try on a custom hairstyle?**\n\n**A:** It's a cool idea, but we're not able to support custom hairstyles right now. Right now, those custom hairdos need heavy optimization to look natural. But if you still want to personalize something, feel free to reach out to our customer success team at [YouCamOnlineEditor_API@perfectcorp.com](mailto:YouCamOnlineEditor_API@perfectcorp.com). Let us know what kind of hairstyles you're thinking of, feel free to send sample pics and tell us who you're trying to reach and how big your market is. Let's build something cool together.\n" }, { "name": "AI Hair Extension", "description": "### AI Hair Extension\nDiscover Your Perfect Hair Extension Match with AI\u200b\nExperiment with a variety of lengths\u2014from long to extra-long\u2014styles, colors, and bangs, all from the comfort of your device. No more guessing games\u2014see exactly how each hair extension style looks on you with the advanced Generative AI. Make informed styling decisions before committing to a new look.\u200b\nWith the advanced Hair Extension Try-On, which naturally blends with your current hair length, it\u2019s the perfect time to experiment with super-long styles.\n\nUse case:\n![AI Hair Extension](https://bcw-media.s3.ap-northeast-1.amazonaws.com/YCE_web_Hair_Extension_Filter_S2_img_07_098b6e08c4.jpg \"AI Hair Extension\")\n\n![AI Hair Extension](https://bcw-media.s3.ap-northeast-1.amazonaws.com/YCE_web_Hair_Extension_Filter_S1_img_01_eab88fe3e2.jpg \"AI Hair Extension\")\n\nSuggestions for How to Shoot:\n![Suggestions for How to Shoot](https://bcw-media.s3.ap-northeast-1.amazonaws.com/AI_Hair_Extension_recommendation_ba24bd5d92.png \"Suggestions for How to Shoot\")\n\n### Supported Formats & Dimensions\n|AI Feature|Supported Dimensions|Supported File Size|Supported Formats|\n| ---- | ---- | ---- | ---- |\n|AI Hair Extension|long side <= 1024, face width >= 128, face pose: -10 < pitch < +10, -45 < yaw < +45, -15 < roll < +15, single face only, need to show full face|< 10MB|jpg/jpeg|\n\n### Error Codes\n|Error Code|Description|\n| ---- | ---- |\n|error_no_shoulder\t|Shoulders are not visible in the source image\n|error_large_face_angle\t|The face angle in the uploaded image is too large\n|error_insufficient_landmarks\t|Cannot detect sufficient face or body landmarks in the source image\n|error_hair_too_short\t|Input hair is too short\n|error_face_pose\t|The face pose of source image is unsupported\n|error_bald_image\t|Input hairstyle is bald\n" }, { "name": "AI Hair Bang Generator", "description": "### AI Hair Bang Generator\nTry on Your Perfect Hair Bangs with AI\nRealistic Looks: Experiment with realistic bangs and discover the style that best complements your face.\u200b\nVersatile Styling Options: Explore a wide range of bangs styles to suit every personality and occasion.\u200b\nEffortless Experience: Enjoy a user-friendly interface that makes trying new bangs easy and fun\u200b.\n\nWant to see more Hair Bang styles? Please refer to https://yce.perfectcorp.com/bangs-filter.\n\nUse case:\n\n![AI Hair Bang Generator](https://bcw-media.s3.ap-northeast-1.amazonaws.com/hair_style_v1_video_1200x674px_1_259f619dfd.png \"AI Hair Bang Generator\")\n\n![AI Hair Bang Generator](https://bcw-media.s3.ap-northeast-1.amazonaws.com/hair_style_v1_video_1200x674px_2_7146754733.png \"AI Hair Bang Generator\")\n\n\nSuggestions for How to Shoot:\n![Suggestions for How to Shoot](https://bcw-media.s3.ap-northeast-1.amazonaws.com/AI_Hair_Extension_recommendation_ba24bd5d92.png \"Suggestions for How to Shoot\")\n\n### Supported Formats & Dimensions\n|AI Feature|Supported Dimensions|Supported File Size|Supported Formats|\n| ---- | ---- | ---- | ---- |\n|AI Hair Bang Generator|long side <= 1024, face width >= 128, face pose: -10 < pitch < +10, -45 < yaw < +45, -15 < roll < +15, single face only, need to show full face|< 10MB|jpg/jpeg/png|\n\n### Error Codes\n|Error Code|Description|\n| ---- | ---- |\n|error_no_shoulder\t|Shoulders are not visible in the source image\n|error_large_face_angle\t|The face angle in the uploaded image is too large\n|error_insufficient_landmarks\t|Cannot detect sufficient face or body landmarks in the source image\n|error_hair_too_short\t|Input hair is too short\n|error_face_pose\t|The face pose of source image is unsupported\n|error_bald_image\t|Input hairstyle is bald\n" }, { "name": "AI Hair Volume Generator", "description": "### AI Hair Volume Generator\nEnhance Your Look with Fuller, More Voluminous Hair Instantly!\u200b\nAdd natural volume to fine or thinning hair. Seamlessly fill gaps or add hair with AI. Works for all hair types: straight, curly, thin. Perfect for dating profiles, resumes & more.\nOur AI tool helps you achieve perfect hair volume and density in all your photos, whether for personal, professional, or social use. Say goodbye to bad hair days in pictures and hello to fresh, voluminous hair every time.\n\nUse case:\n![AI Hair Volume Generator](https://bcw-media.s3.ap-northeast-1.amazonaws.com/YCE_web_Hair_Volume_Filter_S4_img_01_836436ca00.jpg \"AI Hair Volume Generator\")\n\n![AI Hair Volume Generator](https://plugins-media.makeupar.com/smb/blog/post/2024-08-26/51eadc51-aaa7-4ebc-ac78-e389be5e16b0.jpg \"AI Hair Volume Generator\")\n\nSuggestions for How to Shoot:\n![Suggestions for How to Shoot](https://bcw-media.s3.ap-northeast-1.amazonaws.com/AI_Hair_Extension_recommendation_ba24bd5d92.png \"Suggestions for How to Shoot\")\n\n### Supported Formats & Dimensions\n|AI Feature|Supported Dimensions|Supported File Size|Supported Formats|\n| ---- | ---- | ---- | ---- |\n|AI Hair Volume Generator|long side <= 1024, face width >= 128, face pose: -10 < pitch < +10, -45 < yaw < +45, -15 < roll < +15, single face only, need to show full face|< 10MB|jpg/jpeg/png|\n\n### Error Codes\n|Error Code|Description|\n| ---- | ---- |\n|error_no_shoulder\t|Shoulders are not visible in the source image\n|error_large_face_angle\t|The face angle in the uploaded image is too large\n|error_insufficient_landmarks\t|Cannot detect sufficient face or body landmarks in the source image\n|error_hair_too_short\t|Input hair is too short\n|error_face_pose\t|The face pose of source image is unsupported\n|error_bald_image\t|Input hairstyle is bald\n" }, { "name": "AI Wavy Hair", "description": "### AI Wavy Hair\nWhether you're dreaming of bouncy ringlets, loose waves, or a bold curly statement, the YouCam Online Editor\u2019s curly hair filter lets you experiment with a fresh, fabulous hairstyle in seconds\u2014all from the comfort of home.\n\nWhether you\u2019re testing a soft wave or a wild afro, YouCam delivers precision and realism that other tools can\u2019t match. It\u2019s perfect for anyone wanting to experiment nobel hairstyle risk-free and make people look forward to their next salon visit.\n\n\n![](https://plugins-media.makeupar.com/smb/blog/post/2025-04-01/webp_03963789-fb1e-4ad8-be4d-48932e247376.jpg)\n\n![](https://plugins-media.makeupar.com/smb/blog/post/2025-03-20/b25b228a-259b-4efb-a7c1-31d200b62e8c.jpg)\n\nSuggestions for How to Shoot:\n![Suggestions for How to Shoot](https://bcw-media.s3.ap-northeast-1.amazonaws.com/AI_Hair_Extension_recommendation_ba24bd5d92.png \"Suggestions for How to Shoot\")\n\n### Supported Formats & Dimensions\n|AI Feature|Supported Dimensions|Supported File Size|Supported Formats|\n| ---- | ---- | ---- | ---- |\n|AI Wavy Hair|long side <= 1024, face width >= 128, face pose: -10 < pitch < +10, -45 < yaw < +45, -15 < roll < +15, single face only, need to show full face|< 10MB|jpg/jpeg/png|\n\n### Error Codes\n|Error Code|Description|\n| ---- | ---- |\n|error_no_shoulder\t|Shoulders are not visible in the source image\n|error_large_face_angle\t|The face angle in the uploaded image is too large\n|error_insufficient_landmarks\t|Cannot detect sufficient face or body landmarks in the source image\n|error_hair_too_short\t|Input hair is too short\n|error_face_pose\t|The face pose of source image is unsupported\n" }, { "name": "AI Hair Color V1", "description": "### AI Hair Color\nExplore a wide range of hair colors with our hair color changer! Try the hair color you've always dreamed of and experiment with new shades you\u2019ve never tried before. Easily adjust the intensity of your chosen color with sliders for a customized look.\n\n#### Upload Your Image\nUpload the photo you want to change hair color for.\n#### Choose Preset Colors or Customize by Pattern and Palettes\nChoose from predefined color presets or fine tune by adjusting the ombre coverage and blend for unlimited possibilities!\n\n> **Warning:** If both a preset and pattern + palettes are specified, the preset will take priority.\n\n> **Warning:** Your source image needs to contain the hair section for dyeing, so double-check before applying. Make sure your source image includes the hair area you want to dye \u2014 it's your responsibility to get it right.\n\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/hair_color_s2_poster_dt_v2_49198cabc0.png)\n\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/01_1_1_8365c3b503.jpg)\n\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/01_2_1_abfcdb7eba.jpg)\n\n## File Specs & Errors\n### Supported Formats & Dimensions\n|AI Feature|Supported Dimensions|Supported File Size|Supported Formats|\n| ---- | ---- | ---- | ---- |\n|AI Hair Color|long side < 1920, face width >= 100|< 10MB|jpg/jpeg/png|\n\n### Error Codes\n|Error Code|Description|\n| ---- | ---- |\n|error_below_min_image_size|the size of the source image is smaller than minimum (expect: width >= 100px, height >= 100px)\n|error_exceed_max_image_size|the size of the source image is larger than maximum (expect: width < 1920px, height < 1080px)\n\n### Environment & Dependency\n| Sample Code Language / Tool | Recommended Runtime Versions |\n|---|---|\n| cURL | cURL 8.x |\n| Node.js (JavaScript) | Node.js 18.x/20.x LTS |\n| JavaScript | Compatible with Chromium v100 |\n| PHP | PHP 8.1+ |\n| Python | Python 3.10+ |\n| Java | JDK 1.8 or 21 LTS |\n" }, { "name": "AI Hair Color", "description": "### AI Hair Color\nExplore a wide range of hair colors with our hair color changer! Try the hair color you've always dreamed of and experiment with new shades you\u2019ve never tried before. Easily adjust the intensity of your chosen color with sliders for a customized look.\n\n#### Upload Your Image\nUpload the photo you want to change hair color for.\n#### Choose Preset Colors or Customize by Pattern and Palettes\nChoose from predefined color presets or fine tune by adjusting the ombre coverage and blend for unlimited possibilities!\n\n> **Warning:** If both a preset and pattern + palettes are specified, the preset will take priority.\n\n> **Warning:** Your source image needs to contain the hair section for dyeing, so double-check before applying. Make sure your source image includes the hair area you want to dye \u2014 it's your responsibility to get it right.\n\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/hair_color_s2_poster_dt_v2_49198cabc0.png)\n\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/01_1_1_8365c3b503.jpg)\n\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/01_2_1_abfcdb7eba.jpg)\n\n## File Specs & Errors\n### Supported Formats & Dimensions\n|AI Feature|Supported Dimensions|Supported File Size|Supported Formats|\n| ---- | ---- | ---- | ---- |\n|AI Hair Color|long side < 1920, face width >= 100|< 10MB|jpg/jpeg/png|\n\n### Error Codes\n|Error Code|Description|\n| ---- | ---- |\n|error_below_min_image_size|the size of the source image is smaller than minimum (expect: width >= 100px, height >= 100px)\n|error_exceed_max_image_size|the size of the source image is larger than maximum (expect: width < 1920px, height < 1080px)\n\n### Environment & Dependency\n| Sample Code Language / Tool | Recommended Runtime Versions |\n|---|---|\n| cURL | cURL 8.x |\n| Node.js (JavaScript) | Node.js 18.x/20.x LTS |\n| JavaScript | Compatible with Chromium v100 |\n| PHP | PHP 8.1+ |\n| Python | Python 3.10+ |\n| Java | JDK 1.8 or 21 LTS |\n" }, { "name": "AI Image Extender", "description": "### AI Image Extender\nExperience vibrant AI Outpainting with our cutting-edge AI Image Extender. Seamlessly expand images in any ratio, bringing out your creativity with our advanced AI technology. Preserve the highest quality while expanding your photos without compromising on style or aesthetics. Instantly transform your photos with one-click automatic background enlargement thanks to our user-friendly AI tool. Thanks to our advanced context-aware technology, we ensure a seamless and captivating experience for every viewer.\n\n![AI Image Extender](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_web_outpainting_S1_img_03_cf19a018d9.jpg \"AI Image Extender\")\n\nWhether you're aiming for Instagram glory or framing a digital masterpiece, select from a variety of sizes and ratios for that perfect fit. As you tweak and transform, our AI seamlessly weaves its magic, ensuring the expanded areas blend flawlessly with your original photo.\n\n![AI Image Extender](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_web_outpainting_S1_img_01_1876fb85a5.jpg \"AI Image Extender\")" }, { "name": "AI Photo Lighting", "description": "### AI Photo Lighting\nBrighten your images with Our AI image brightening tool effortlessly. With the legendary AI technology, lighten up any image of your choice.\nBrighten your dark photos or images with our AI Photo Lighting tool, illuminating your memories in a flash.\n\nBefore\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_lighting_v3_poster_1_b7d976b686.jpg)\nAfter\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_lighting_v3_poster_2_79d3be33bc.jpg)\nBrighten low-light photos effortlessly using AI tool, bringing out stunning details and vibrant colors.\n\n\n\nBefore\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_lighting_v6_poster_1_2422530612.jpg)\nAfter\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_lighting_v6_poster_2_63f1ecc244.jpg)\nBrighten your product pictures with AI Lighting tool for a captivating and stunning presentation." }, { "name": "AI Photo Color Correction", "description": "### AI Color Correction\nPerfect AI Color Correction let you automatically adjust\u00a0saturation, temperature, and hue of photos with ease. Adjust white balance to correct color temperature, enhance saturation and make it vibrant, correct exposure level to balance brightness, remove color casts or tints, improve skin tones for a nature-looking portrait, enhance shadow and highlight details, remove noise and improve clarity, or even apply creative color grading effects all in one touch. With AI Color Correction, you can instantly generate 4 different color graded versions of your photos, each with unique color tones ranging from warm to cool within seconds.\n\nSample\nBefore:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/color_correction_topbanner_before_dt_100_45429e8625.jpg)\n\nAfter:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/color_correction_topbanner_after_dt_100_ef9f9c48ed.jpg)\n\n\n\nBefore:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/color_correction_s1_image_before_dt_fa73b5d41a.jpg)\n\nAfter\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/color_correction_s1_image_after_dt_a3e88a101b.jpg)\n" }, { "name": "AI Replace", "description": "### Al Replace\nReplace unwanted elements with new objects using AI Replace. By using this API, you can instantly remove unwanted object from your photo and replace it with a new one just by using text. Eliminate anything from bags to cars and beyond.\u200b\n\nSample:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_web_AI_replace_S3_feature_img_02_a73a26bcc3.jpg)\n\n\nFor content creators aiming to perfect their social media presence, AI Replace offers a hassle-free way to polish travel photos or promotional images. Remove and replace elements with ease, ensuring your content stands out.\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_web_AI_replace_S3_feature_img_03_42c9cd98d0.jpg)\n\n\nCreate stunning room mockups with AI Replace by filling empty spaces with aesthetically pleasing furniture and objects, transforming the perception of any space.\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_web_AI_replace_S3_feature_img_04_4d2d82f76e.jpg)" }, { "name": "AI Makeup Transfer", "description": "### AI Makeup Transfer\nJust Upload a Desired Photo with the Look You Like! AI Makeup Transfer makes it easy and fun to experiment with different looks by letting you to upload desired photo to try them one by one. Have any makeup look you want to try now? Let us amaze you with AI Makeup Transfer!\n\nFirst, upload a photo of yourself where your face and its features are clearly visible as the target image.\n\nThen, upload a photo of your favorite makeup look as the reference image. \n\nThere you have it - an AI Makeup Transferred photo. \n\nSamples:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/YCE_web_Makeup_Transfer_s1_img_be53c5c345.jpg)\n\n![](https://plugins-media.makeupar.com/smb/blog/post/2024-06-24/fda62e5d-ba58-4ecf-838a-c7d5f804c77b.jpg)\n\n### Supported Formats & Dimensions\n|AI Feature|Supported Dimensions|Supported File Size|Supported Formats|\n| ---- | ---- | ---- | ---- |\n|AI Makeup Transfer|1024x1024 (long side <= 1024), single face only, need to show full face|< 10MB|jpg/jpeg/png|\n\n### Error Codes\n|Error Code|Description|\n| ---- | ---- |\n|error_src_no_face\t|No face detected in the user image\n|error_ref_no_face\t|No face detected in the reference image\n|error_src_face_too_small\t|Face in the user image is too small\n|error_ref_face_too_small\t|Face in the reference image is too small\n|error_src_large_face_angle\t|Frontal face required in the user image\n|error_ref_large_face_angle\t|Frontal face required in the reference image\n|error_src_eye_closed\t|Eye is closed in the user image\n|error_ref_eye_closed\t|Eye is closed in the reference image\n|error_src_eye_occluded\t|Eye is occluded in the user image\n|error_ref_eye_occluded\t|Eye is occluded in the reference image\n|error_src_lip_occluded\t|Lip is occluded in the user image\n|error_ref_lip_occluded\t|Lip is occluded in the reference image\n|error_inappropriate_ref_case01\t|For both eyes, hair is too close to eye or skin region beside eyetail is not large enough in the reference image\n|error_inappropriate_ref_case02\t|For one eye, hair is too close to eye or skin region beside eyetail is not large enough in the reference image. The other one is not frontal enough in the reference image\n" }, { "name": "AI Face Swap", "description": "### AI Face Swap\nUsing AI Face Swap for hyper-realistic effect with multiple faces supported.\u200b Our face swap artificial intelligence supports swapping one or multiple faces. Either for creating funny pictures of faces, or need a professional tool, we've got you covered.\n\n## Integration Guide\n### How to implement AI Face Swap\n#### Step 1: Obtain credentials\n\n* You need a **Client ID (Your API Key)** and **RSA public key (Your Secret Key)** from the [API Console](https://yce.perfectcorp.com/api-console/en/account-settings/)\n.\n* These are used to generate an encrypted ID token for authentication.\n\n---\n\n#### Step 2: Authenticate and get an access token\n\n1. Construct a string containing your client ID and a current timestamp.\n\n ```\n client_id=YOUR_CLIENT_ID×tamp=UNIX_TIMESTAMP\n ```\n2. Encrypt this string with your RSA public key.\n3. Send a request to:\n\n ```\n POST https://yce-api-01.perfectcorp.com/s2s/v1.0/client/auth\n Content-Type: application/json\n ```\n\n Body:\n\n ```json\n {\n \"client_id\": \"YOUR_CLIENT_ID\",\n \"id_token\": \"ENCRYPTED_STRING\"\n }\n ```\n4. The response contains an **access_token**. Keep it safe, as you will need it for subsequent calls.\n\n---\n\n#### Step 3: Upload source and reference images\n\n1. Request upload URLs from the API:\n\n ```\n POST https://yce-api-01.perfectcorp.com/s2s/v1.1/file/face-swap\n Authorization: Bearer ACCESS_TOKEN\n Content-Type: application/json\n ```\n\n Body:\n\n ```json\n {\n \"files\": [\n {\n \"file_name\": \"target.jpg\",\n \"file_size\": 123456,\n \"content_type\": \"image/jpeg\"\n }\n ]\n }\n ```\n2. The response provides a pre-signed upload URL and a `file_id`.\n3. Upload your file with an HTTP PUT request to the given URL.\n4. Store the `file_id` for later use. Repeat this for both **target** and **reference** images.\n\n---\n\n#### Step 4: Pre-process the target image (face detection)\n\n1. Create a pre-process task:\n\n ```\n POST https://yce-api-01.perfectcorp.com/s2s/v1.0/task/face-swap/pre-process\n Authorization: Bearer ACCESS_TOKEN\n Content-Type: application/json\n ```\n\n Body:\n\n ```json\n {\n \"request_id\": 1,\n \"payload\": {\n \"file_sets\": {\n \"src_ids\": [\"TARGET_FILE_ID\"]\n },\n \"actions\": [\n { \"id\": 0 }\n ]\n }\n }\n ```\n2. The API returns a `task_id`.\n3. Poll task status at:\n\n ```\n GET https://yce-api-01.perfectcorp.com/s2s/v1.0/task/face-swap/pre-process?task_id=TASK_ID\n ```\n4. When finished, you receive a list of detected faces with bounding boxes.\n\n---\n\n#### Step 5: Run the face swap task\n\n1. Build a **face mapping** array. For each detected face:\n\n * If you want to ***swap it***, set `{ \"index\": 0, \"position\": 0 }`.\n * If you want to ***keep it unchanged***, set `{ \"index\": -1, \"position\": -1 }`.\n2. Send the main task request:\n\n ```\n POST https://yce-api-01.perfectcorp.com/s2s/v1.0/task/face-swap\n Authorization: Bearer ACCESS_TOKEN\n Content-Type: application/json\n ```\n\n Body:\n\n ```json\n {\n \"request_id\": 2,\n \"payload\": {\n \"file_sets\": {\n \"src_ids\": [\"TARGET_FILE_ID\"],\n \"ref_ids\": [\"REFERENCE_FILE_ID\"]\n },\n \"actions\": [\n {\n \"id\": 0,\n \"params\": {\n \"face_mapping\": [\n { \"index\": 0, \"position\": 0 },\n { \"index\": -1, \"position\": -1 }\n ]\n }\n }\n ]\n }\n }\n ```\n3. The response returns a `task_id`.\n\n---\n\n#### Step 6: Poll task status and retrieve result\nIt\u2019s necessary to implement a timed loop that queries the task status at regular intervals within the allowed polling window.\n1. Poll at:\n\n ```\n GET https://yce-api-01.perfectcorp.com/s2s/v1.0/task/face-swap?task_id=TASK_ID\n ```\n2. When `status` is `success`, the response contains a URL for the generated image.\n3. Download or display the image from that URL.\n\n---\n\n#### Step 7: Integrate into your platform\n\n* On a **web frontend**, you can directly implement this with JavaScript using fetch or Axios.\n* On a **backend** (Node.js, Python, Java, PHP, etc.), you can use the same endpoints with standard HTTP libraries.\n* Always secure the **client credentials** and perform authentication safely. Avoid embedding private keys directly in client-side code in production.\n* Implement retry and error handling since the tasks run asynchronously.\n\n\n### Debugging Guide\n1. **Invalid TaskId Error**\n
**Why:** You\u2019ll receive an InvalidTaskId error if you attempt to check the status of a task that has timed out. Therefore, once an AI task is initiated, you\u2019ll need to poll for its status within the polling_interval until the status changes to either success or error.\n
**Solution:** To avoid the task becoming invalid, it\u2019s necessary to implement a timed loop that queries the task status at regular intervals within the allowed polling window.\n\n1. **Why are some faces not detected in my source image**\n
**Why:** Reason: The face must be clearly visible, not covered or obstructed, and large enough within the image\n
**Solution:** Try taking a photo where the face appears larger and is clearly visible without any covering or obstruction\n\n---\n\n## Inputs & Outputs\n\n### Real-world examples:\nMultiple faces swap sample:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/dt_yce_face_swap_S2_img_04_d4b747a41d.jpg)\n\nSingle face swap sample:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/dt_yce_face_swap_S2_img_05_8e68faff2c.jpg)\n\n### Suggestions for How to Shoot:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/strapi/assets/webp_AI%20Skin%20Analysis_camera_f93315b088.png)\n\n\n## File Specs & Errors\n### Supported Formats & Dimensions\n|AI Feature|Supported Dimensions|Supported File Size|Supported Formats|\n| ---- | ---- | ---- | ---- |\n|AI Face Swap|Input and output: the long side must be less than or equal to 4096 pixels|< 10MB|jpg/jpeg/png|\n\n\n### Error Codes\n| Error Code | Description |\n| ------------------ | ----------- |\n| exceed_max_filesize | The input file size exceeds the maximum limit |\n| invalid_parameter | The parameter value is invalid |\n| error_download_image | There was an error downloading the source image |\n| error_download_mask | There was an error downloading the mask image |\n| error_decode_image | There was an error decoding the source image |\n| error_decode_mask | There was an error decoding the mask image |\n| error_download_video | There was an error downloading the source video |\n| error_decode_video | There was an error decoding the source video |\n| error_nsfw_content_detected | NSFW content was detected in the source image |\n| error_no_face | No face was detected in the source image |\n| error_pose | Failed to detect pose in the source image |\n| error_face_parsing | Failed to perform face parsing on the source image |\n| error_inference | An error occurred in the inference pipeline |\n| exceed_nsfw_retry_limits | Retry limits exceeded to avoid generating NSFW image |\n| error_upload | There was an error uploading the result image |\n| error_multiple_people | People count exceeds the maximum limit |\n| error_no_shoulder | Shoulders are not visible in the source image |\n| error_large_face_angle | The face angle in the uploaded image is too large |\n| error_unsupport_ratio | The aspect ratio of the input image is unsupported |\n| unknown_internal_error | Other internal errors |\n" }, { "name": "AI Video Enhance", "description": "### AI Video Enhance\nFix blur, adjust sharpness and brightness, and instantly transform low-quality videos into clear, high-quality content with AI. From 480p to 4K, unblur, upscale, and boost quality with the video enhancer\u2014no skills needed.\n\nSupported format: .mp4, .mov are supported. Please keep the duration under 1 minute.\nMaximun output resolution: up to 4K.\n\nSample usage cases:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_web_video_enhancer_S2_feature_video_03_S_0_10169a6902.jpg)\n\n![](https://plugins-media.makeupar.com/smb/blog/post/2024-02-22/671a9cae-c46a-4422-be8f-2a9bec442f16.jpg)" }, { "name": "AI Headshot Generator", "description": "### AI Headshot Generator\nTransform your photos into stunning professional deadshots with our AI Headshot Generator. Elevate your headshots quickly and effectively using our powerful AI tools designed to deliver professional-quality results.\n* Variety of Styles: From polished LinkedIn headshots and professional business headshots to creative model headshots, our AI headshot generator helps you select the perfect look to suit your needs.\n* Professional Results: Leveraging AI to ensure your headshots look natural and flattering, making a strong impression on potential employers and clients.\n* Convenience: Generate multiple AI headshots anytime, anywhere, without the need for a photographer. Perfect for busy professionals.\n\nFor more AI Headshot styles, please refer to https://yce.perfectcorp.com/ai-headshot-generator.\n\nUse cases:\n![AI Headshot Generator](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_headshot_s2_img_03_4b55742358.jpg \"AI Headshot Generator\")\n\n![AI Headshot Generator](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_headshot_s1_img_1_d03183d7e0.jpg \"AI Headshot Generator\")\n\n\nSuggestions for How to Shoot:\n![Suggestions for How to Shoot](https://bcw-media.s3.ap-northeast-1.amazonaws.com/AI_Hair_Extension_recommendation_ba24bd5d92.png \"Suggestions for How to Shoot\")\n\n### Supported Formats & Dimensions\n|AI Feature|Supported Dimensions|Supported File Size|Supported Formats|\n| ---- | ---- | ---- | ---- |\n|AI Headshot |Ensure the input image contains a single person with both shoulder points and a full face visible from OpenPose, and that its short side is \u2264 1024 pixels\u2014otherwise, the engine will automatically resize it to 1024. Output: long side <= 1024|< 10MB|jpg/jpeg|\n" }, { "name": "AI Studio Generator", "description": "### AI Studio Generator\nEmbrace the excellence of studio kike AI Portrait Generator. Transform your selfie into a studio-quality portrait in a flash\u200b.\n* Studio-Free Convenience: No need for a photographer or studio visits\u2014create studio-quality artistic photos anytime, anywhere\u200b\n* Quick Photo Transformation: Fast processing for instant high-quality artistic photo results, ideal for quick updates\n* High-Quality Artistic Output: Delivers professional-standard artistic photos with clear details, perfect lighting, just like you've taken the photos in a studio \n\nUse cases:\n![AI Studio Generator](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_web_AI_studio_S1_img_19b627b6af.jpg \"AI Studio Generator\")\n\n![AI Studio Generator](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_web_AI_studio_S2_img_01_2e318817e9.jpg \"AI Studio Generator\")\n\n\nSuggestions for How to Shoot:\n![Suggestions for How to Shoot](https://bcw-media.s3.ap-northeast-1.amazonaws.com/AI_Hair_Extension_recommendation_ba24bd5d92.png \"Suggestions for How to Shoot\")\n\n### Supported Formats & Dimensions\n|AI Feature|Supported Dimensions|Supported File Size|Supported Formats|\n| ---- | ---- | ---- | ---- |\n|AI Studio|Please ensure the input image has one face, a short side of at least 200 pixels, and a long side no greater than 1920 pixels; the engine will select the largest face if multiple are present, and the output resolution will not exceed 960\u00d71280 (W\u00d7H)|< 10MB|jpg/jpeg/png|\n\n### Error Codes\n|Error Code|Description|\n| ---- | ---- |\n|error_below_min_image_size\t|Input image resolution is too small|\n|error_exceed_max_image_size\t|Input image resolution is too large|\n" }, { "name": "AI Avatar Generator", "description": "### AI Avatar Generator\nFor the AI magic avatar tool, this app uses the technology of image-to-image. which means the avatar is generated based on your photo. Once the photos are selected by the users, the technology embedded in the app starts analyzing and learning the user's facial traits.\n\nFor more avatar styles, please refer to https://yce.perfectcorp.com/avatar\n\nUse cases:\n![AI Avatar Generator](https://bcw-media.s3.ap-northeast-1.amazonaws.com/Christmas_Avatar_b861c35edf.jpg \"AI Avatar Generator\")\n\n![AI Avatar Generator](https://plugins-media.makeupar.com/smb/blog/post/2023-04-06/fc2c3b2e-2b7f-48c9-96c1-cdb780f9dc1d.jpg \"AI Avatar Generator\")\n\n\nSuggestions for How to Shoot:\n![Suggestions for How to Shoot](https://bcw-media.s3.ap-northeast-1.amazonaws.com/AI_Hair_Extension_recommendation_ba24bd5d92.png \"Suggestions for How to Shoot\")" }, { "name": "AI Face Swap (video)", "description": "### AI Video Face Swap\nVideo face swapping is an AI-powered process that uses YouCam\u2019s AI Video Face Swap API to replace one person's face with another in a video.\nWith advanced AI technology, the AI video face swap delivers remarkably realistic results. The facial expressions, lighting, and skin tones are finely tuned to ensure that the swapped faces blend seamlessly with the original footage. \n\n> **Note:** This API supports video with single face only. For customizable solution, please [contact us](mailto:YouCamOnlineEditor_API@perfectcorp.com).\n\nSample usage cases:\n![](https://plugins-media.makeupar.com/smb/blog/post/2024-08-23/b1f96100-37d6-4c28-b467-d397e9c3a25d.jpg)\n\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/dt_yce_video_face_swap_S3_video_03_28785ebe0c.jpg)\n\n![](https://plugins-media.makeupar.com/smb/story/2024-09-12/3582f617-e88e-4219-9e72-43d4c26791cd.png)\n" }, { "name": "AI Style Transfer (video)", "description": "### AI Video Style Transfer\nCreate unique videos with our AI Video Filters and Effects. Easily enhance each video with stunning AI styles. AI Video Filters with Instant Transformation. Experience a seamless transformation with AI video filters that apply stunning effects instantly. Choose from an array of unique styles, including pop art, retro, anime, and more, to add depth and creativity to every frame.\n\nSample usage cases:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/dt_yce_video_style_transfer_S1_video_1_0_6d571a8bbb.jpg)\n\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_web_video_style_transfe_S2_feature_03_0_6dd652a6f2.jpg)\n" }, { "name": "AI Skin Analysis V1", "description": "### AI Skin Analysis V1 API\n![](https://d3ss46vukfdtpo.cloudfront.net/static/media/img_demostore_skincarelive_topbanner.0cffe3a7.jpg)\nAI skincare analysis technology harnesses the power of artificial intelligence to analyze various aspects of the skin, from texture and pigmentation to hydration and pore size, with remarkable precision. By employing advanced algorithms and machine learning, AI skin analysis can offer personalized recommendations and skincare routines tailored to an individual's unique skin type and concerns.\n\nThis not only enhances the effectiveness of skincare products but also empowers users to make informed decisions about their skincare regimen. With the integration of AI skin analysis, individuals can now embark on a journey towards healthier, more radiant skin, guided by data-driven insights and the promise of more effective skincare solutions.\n\n\n## Integration Guide\n### How to Take Photos for AI Skin Analysis\n* Take a selfie facing forward\n - Just one clear shot, looking straight into the camera. Leave your hair down so it falls over your chest, and make sure you're staring directly ahead for that front-on view.\n - Instead, use the JS Camera Kit to take a photo. Just leave your hair down so it falls over your chest. Don't tie it up.\n\n### How to Detect Skin Concerns by AI\n1. **Resize your source image**
\n Resize your photo to fit the supported dimensions - up to 1920 pixels on the long side and at least 480 pixels on the short side for SD, or up to 2560 pixels on the long side and at least 1080 pixels on the short side for HD. See details in **[File Specs & Errors](#tag/AI-Skin-Analysis-V1/File-Specs-and-Errors)**\n\n2. **Upload file using the File API**
\n Using the ***v1.1/file/skin-analysis*** API to upload a target user image.\n - Image Requirements\n - See details in **[File Specs & Errors](#tag/AI-Skin-Analysis-V1/File-Specs-and-Errors)**.\n - ***Important***: Simply calling the File API does not upload your file. You must **manually upload** the file to the **URL provided in the File API response**. That URL is your upload destination, make sure the file is successfully transferred there before proceeding.
\n Before calling the AI API, ensure your file has been successfully uploaded. Use the File API to retrieve an upload URL, then upload your file to that location. Once the upload is complete, you'll receive a ***file_id*** in the response, this ID is what you'll use to access AI features related to that file.\n\n > **Warning:** Please note that, you will get an 500 Server Error / unknown_internal_error or 404 Not Found error when using AI APIs if you do not upload the file to the URL provided in the File API response.\n\n3. **Run an AI Skin Analysis task**
\n Once the upload is complete, you can select 4, 7, or 14 skin concerns to analyze using your file ID. Please refer to the **[Inputs & Outputs](#tag/AI-Skin-Analysis-V1/Inputs-and-Outputs)**.
\n Subsequently, calling POST 'task/skin-analysis' with the\n File ID executes the enhance task and obtains a ***task_id***.\n\n4. **Polling to check the status of a task until it succeed or error**
\nThis ***task_id*** is used to monitor the task's status through polling GET 'task/skin-analysis' to retrieve the current engine status. Until the engine completes the task, the status will remain 'running', and no units will be consumed during this stage.\n\n **Warning:** Please note that, **Polling** to check the status of a task based on it's ***polling_interval*** is mandotary. A task will be timed out if there is no polling request within the ***polling_interval***, even if the task is processed succefully(Your unit(s) will be consumed).\n\n > **Warning:** You will get a ***InvalidTaskId*** error once you check the status of a timed out task. So, once you run an AI task, you need to **polling** to check the status within the ***polling_interval*** until the status become either *success* or *error*.\n\n5. **Get the result of an AI task once success**
\nThe task will change to the 'success' status after the engine successfully processes your input file and generates the resulting image. You will get an url of the processed image and a dst_id that allow you to chain another AI task without re-upload the result image.\nYour units will only be consumed in this case. If the engine fails to process the task, the task's status will change to 'error' and no unit will be consumed.
\nWhen deducting units, the system will prioritize those nearing expiration. If the expiration date is the same, it will deduct the units obtained on the earliest date.\n\n\n### Debugging Guide\n> **Warning:** Please be advised that the system requires processing **exactly 4, 7, or 14** distinct skin concerns at one time. Simultaneous use of SD and HD skin concern parameters is **NOT** supported. Attempting to deviate from these specifications will result in an ***InvalidParameters*** error.\n\n * For example, if you run a task with 5 HD skin concerns, you will get an error as following:\n ```json\n {\n \"status\": 400,\n \"error\": \"must select 4, 7 or 14 distinct dst_actions\",\n \"error_code\": \"InvalidParameters\"\n }\n ```\n * If you mix using HD and SD skin concerns, you will get an error as following:\n ```json\n {\n \"status\": 400,\n \"error\": \"cannot mix HD and SD dst_actions\",\n \"error_code\": \"InvalidParameters\"\n }\n ```\n * If you misspell a skin concern or sending unknown skin concerns, you will get an error as following:\n ```json\n {\n \"status\": 400,\n \"error\": \"Not available dst_action abc123\",\n \"error_code\": \"InvalidParameters\"\n }\n ```\n\n---\n\n### Real-world examples:\n![](https://plugins-media.makeupar.com/webconsultation/images/skincare-widget/img_webcm_skincare_service_survey_demo.jpg)\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/skin_analysis_s5_poster_3_dt_85efe14952.png)\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/Skincare_Pro_Medspa_Situation_Image_6aea6046f9.jpg)\n\n## Inputs & Outputs\n### Suggestions for How to Shoot:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/strapi/assets/webp_AI%20Skin%20Analysis_camera_f93315b088.png)\n\n> **Warning:** The width of the face needs to be greater than 60% of the width of the image.\n\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/strapi/assets/webp_AI%20Skin%20Analysis_error_src_face_too_small_cr_725792a7fb.png)\n\n### Get Ready to Start Skin Analysis Instructions\n* Take off your glasses and make sure bangs are not covering your forehead\n* Make sure that you\u2019re in a well-lit environment\n* Remove makeup to get more accurate results\n* Look straight into the camera and keep your face in the center\n\n### Output ZIP Data Structure Description\nThe system provides a ZIP file with a 'skinanalysisResult' folder inside. This folder contains a 'score_info.json' file that includes all the detection scores and references to the result images.\n\nThe 'score_info.json' file contains all the skin analysis detection results, with numerical scores and the names of the corresponding output mask files.\n\nThe PNG files are detection result masks that can be overlaid on your original image. Simply use the alpha values in these PNG files to blend them with your original image, allowing you to see the detection results directly on the source image.\n\n### File Structure in the Skin Analysis Result ZIP\n* HD Skincare ZIP\n * skinanalysisResult\n - score_info.json\n - hd_acne_output.png\n - hd_age_spot_output.png\n - hd_dark_circle_output.png\n - hd_droopy_lower_eyelid_output.png\n - hd_droopy_upper_eyelid_output.png\n - hd_eye_bag_output.png\n - hd_firmness_output.png\n - hd_moisture_output.png\n - hd_oiliness_output.png\n - hd_radiance_output.png\n - hd_redness_output.png\n - hd_texture_output.png\n - hd_pore_output_all.png\n - hd_pore_output_cheek.png\n - hd_pore_output_forehead.png\n - hd_pore_output_nose.png\n - hd_wrinkle_output_all.png\n - hd_wrinkle_output_crowfeet.png\n - hd_wrinkle_output_forehead.png\n - hd_wrinkle_output_glabellar.png\n - hd_wrinkle_output_marionette.png\n - hd_wrinkle_output_nasolabial.png\n - hd_wrinkle_output_periocular.png\n\n* SD Skincare ZIP\n * skinanalysisResult\n - score_info.json\n - acne_output.png\n - age_spot_output.png\n - dark_circle_v2_output.png\n - droopy_lower_eyelid_output.png\n - droopy_upper_eyelid_output.png\n - eye_bag_output.png\n - firmness_output.png\n - moisture_output.png\n - oiliness_output.png\n - pore_output.png\n - radiance_output.png\n - redness_output.png\n - texture_output.png\n - wrinkle_output.png\n\n* JSON Data Structure (score_info.json)\n * \"all\": A floating-point value between 1 and 100 representing the general skin condition. A higher score indicates healthier and more aesthetically pleasing skin condition.\n * \"skin_age\": AI-derived skin age relative to the general population distribution across all age groups.\n * Each category contains:\n * \"raw_score\": A floating-point value ranging from 1 to 100. A higher score indicates healthier and more aesthetically pleasing skin condition.\n * \"ui_score\": An integer ranging from 1 to 100. The UI Score functions primarily as a psychological motivator in beauty assessment. We adjust the raw scores to produce more favorable results, acknowledging that consumers generally prefer positive evaluations regarding their skin health. This calibration serves to instill greater confidence in users while maintaining the underlying beauty psychology framework.\n * \"output_mask_name\": The filename of the corresponding output mask image.\n\n * Categories and Descriptions\n * HD Skincare:\n * \"hd_redness\": Measures skin redness severity.\n * \"hd_oiliness\": Determines skin oiliness level.\n * \"hd_age_spot\": Detects age spots and pigmentation.\n * \"hd_radiance\": Evaluates skin radiance.\n * \"hd_moisture\": Assesses skin hydration levels.\n * \"hd_dark_circle\": Analyzes the presence of dark circles under the eyes.\n * \"hd_eye_bag\": Detects eye bags.\n * \"hd_droopy_upper_eyelid\": Measures upper eyelid drooping severity.\n * \"hd_droopy_lower_eyelid\": Measures lower eyelid drooping severity.\n * \"hd_firmness\": Evaluates skin firmness and elasticity.\n * \"hd_texture\": Subcategories[whole]; Analyzes overall skin texture.\n * \"hd_acne\": Subcategories[whole]; Detects acne presence.\n * \"hd_pore\": Subcategories[forehead, nose, cheek, whole]; Detects and evaluates pores in different facial regions.\n * \"hd_wrinkle\": Subcategories[forehead, glabellar, crowfeet, periocular, nasolabial, marionette, whole]; Measures the severity of wrinkles in various facial areas.\n\n * SD Skincare:\n * \"wrinkle\": General wrinkle analysis.\n * \"droopy_upper_eyelid\": Measures upper eyelid drooping severity.\n * \"droopy_lower_eyelid\": Measures lower eyelid drooping severity.\n * \"firmness\": Evaluates skin firmness and elasticity.\n * \"acne\": Evaluates acne presence.\n * \"moisture\": Measures skin hydration.\n * \"eye_bag\": Detects eye bags.\n * \"dark_circle_v2\": Analyzes dark circles using an alternative method.\n * \"age_spot\": Detects age spots.\n * \"radiance\": Evaluates skin brightness.\n * \"redness\": Measures skin redness.\n * \"oiliness\": Determines skin oiliness.\n * \"pore\": Measures pore visibility.\n * \"texture\": Analyzes overall skin texture.\n\n * Sample score_info.json of HD Skincare\n ```json\n {\n \"hd_redness\": {\n \"raw_score\": 72.011962890625,\n \"ui_score\": 77,\n \"output_mask_name\": \"hd_redness_output.png\"\n },\n \"hd_oiliness\": {\n \"raw_score\": 60.74365234375,\n \"ui_score\": 72,\n \"output_mask_name\": \"hd_oiliness_output.png\"\n },\n \"hd_age_spot\": {\n \"raw_score\": 83.23274230957031,\n \"ui_score\": 77,\n \"output_mask_name\": \"hd_age_spot_output.png\"\n },\n \"hd_radiance\": {\n \"raw_score\": 76.57244205474854,\n \"ui_score\": 79,\n \"output_mask_name\": \"hd_radiance_output.png\"\n },\n \"hd_moisture\": {\n \"raw_score\": 48.694559931755066,\n \"ui_score\": 70,\n \"output_mask_name\": \"hd_moisture_output.png\"\n },\n \"hd_dark_circle\": {\n \"raw_score\": 80.1993191242218,\n \"ui_score\": 76,\n \"output_mask_name\": \"hd_dark_circle_output.png\"\n },\n \"hd_eye_bag\": {\n \"raw_score\": 76.67280435562134,\n \"ui_score\": 79,\n \"output_mask_name\": \"hd_eye_bag_output.png\"\n },\n \"hd_droopy_upper_eyelid\": {\n \"raw_score\": 79.05348539352417,\n \"ui_score\": 80,\n \"output_mask_name\": \"hd_droopy_upper_eyelid_output.png\"\n },\n \"hd_droopy_lower_eyelid\": {\n \"raw_score\": 79.97175455093384,\n \"ui_score\": 81,\n \"output_mask_name\": \"hd_droopy_lower_eyelid_output.png\"\n },\n \"hd_firmness\": {\n \"raw_score\": 89.66898322105408,\n \"ui_score\": 85,\n \"output_mask_name\": \"hd_firmness_output.png\"\n },\n \"hd_texture\": {\n \"whole\": {\n \"raw_score\": 66.3921568627451,\n \"ui_score\": 75,\n \"output_mask_name\": \"hd_texture_output.png\"\n }\n },\n \"hd_acne\": {\n \"whole\": {\n \"raw_score\": 59.92677688598633,\n \"ui_score\": 76,\n \"output_mask_name\": \"hd_acne_output.png\"\n }\n },\n \"hd_pore\": {\n \"forehead\": {\n \"raw_score\": 79.59770965576172,\n \"ui_score\": 80,\n \"output_mask_name\": \"hd_pore_output_forehead.png\"\n },\n \"nose\": {\n \"raw_score\": 29.139814376831055,\n \"ui_score\": 58,\n \"output_mask_name\": \"hd_pore_output_nose.png\"\n },\n \"cheek\": {\n \"raw_score\": 44.11081314086914,\n \"ui_score\": 65,\n \"output_mask_name\": \"hd_pore_output_cheek.png\"\n },\n \"whole\": {\n \"raw_score\": 49.23978805541992,\n \"ui_score\": 67,\n \"output_mask_name\": \"hd_pore_output_all.png\"\n }\n },\n \"hd_wrinkle\": {\n \"forehead\": {\n \"raw_score\": 55.96956729888916,\n \"ui_score\": 67,\n \"output_mask_name\": \"hd_wrinkle_output_forehead.png\"\n },\n \"glabellar\": {\n \"raw_score\": 76.7251181602478,\n \"ui_score\": 75,\n \"output_mask_name\": \"hd_wrinkle_output_glabellar.png\"\n },\n \"crowfeet\": {\n \"raw_score\": 83.4361481666565,\n \"ui_score\": 78,\n \"output_mask_name\": \"hd_wrinkle_output_crowfeet.png\"\n },\n \"periocular\": {\n \"raw_score\": 67.88706302642822,\n \"ui_score\": 72,\n \"output_mask_name\": \"hd_wrinkle_output_periocular.png\"\n },\n \"nasolabial\": {\n \"raw_score\": 74.03312683105469,\n \"ui_score\": 74,\n \"output_mask_name\": \"hd_wrinkle_output_nasolabial.png\"\n },\n \"marionette\": {\n \"raw_score\": 71.94477319717407,\n \"ui_score\": 73,\n \"output_mask_name\": \"hd_wrinkle_output_marionette.png\"\n },\n \"whole\": {\n \"raw_score\": 49.64699745178223,\n \"ui_score\": 65,\n \"output_mask_name\": \"hd_wrinkle_output_all.png\"\n }\n },\n \"all\": {\n \"score\": 75.75757575757575\n },\n \"skin_age\": 37\n }\n ```\n * Sample score_info.json of SD Skincare\n ```json\n {\n \"wrinkle\": {\n \"raw_score\": 36.09360456466675,\n \"ui_score\": 60,\n \"output_mask_name\": \"wrinkle_output.png\"\n },\n \"droopy_upper_eyelid\": {\n \"raw_score\": 79.05348539352417,\n \"ui_score\": 80,\n \"output_mask_name\": \"droopy_upper_eyelid_output.png\"\n },\n \"droopy_lower_eyelid\": {\n \"raw_score\": 79.97175455093384,\n \"ui_score\": 81,\n \"output_mask_name\": \"droopy_lower_eyelid_output.png\"\n },\n \"firmness\": {\n \"raw_score\": 89.66898322105408,\n \"ui_score\": 85,\n \"output_mask_name\": \"firmness_output.png\"\n },\n \"acne\": {\n \"raw_score\": 92.29713000000001,\n \"ui_score\": 88,\n \"output_mask_name\": \"acne_output.png\"\n },\n \"moisture\": {\n \"raw_score\": 48.694559931755066,\n \"ui_score\": 70,\n \"output_mask_name\": \"moisture_output.png\"\n },\n \"eye_bag\": {\n \"raw_score\": 76.67280435562134,\n \"ui_score\": 79,\n \"output_mask_name\": \"eye_bag_output.png\"\n },\n \"dark_circle_v2\": {\n \"raw_score\": 80.1993191242218,\n \"ui_score\": 76,\n \"output_mask_name\": \"dark_circle_v2_output.png\"\n },\n \"age_spot\": {\n \"raw_score\": 83.23274230957031,\n \"ui_score\": 77,\n \"output_mask_name\": \"age_spot_output.png\"\n },\n \"radiance\": {\n \"raw_score\": 76.57244205474854,\n \"ui_score\": 79,\n \"output_mask_name\": \"radiance_output.png\"\n },\n \"redness\": {\n \"raw_score\": 72.011962890625,\n \"ui_score\": 77,\n \"output_mask_name\": \"redness_output.png\"\n },\n \"oiliness\": {\n \"raw_score\": 60.74365234375,\n \"ui_score\": 72,\n \"output_mask_name\": \"oiliness_output.png\"\n },\n \"pore\": {\n \"raw_score\": 88.38014125823975,\n \"ui_score\": 84,\n \"output_mask_name\": \"pore_output.png\"\n },\n \"texture\": {\n \"raw_score\": 80.09742498397827,\n \"ui_score\": 76,\n \"output_mask_name\": \"texture_output.png\"\n },\n \"all\": {\n \"score\": 75.75757575757575\n },\n \"skin_age\": 37\n }\n ```\n\n## File Specs & Errors\n### Supported Formats & Dimensions\n|AI Feature|Supported Dimensions|Supported File Size|Supported Formats|\n| ---- | ---- | ---- | ---- |\n|SD Skincare|**long side <= 1920, short side >= 480**|< 10MB|jpg/jpeg/png|\n|HD Skincare|**long side <= 2560, short side >= 1080**|< 10MB|jpg/jpeg/png|\n\n> **Warning:** It is your resposibility to resize input images based on the ***Supported Dimensions*** of HD or SD Skincare before runing AI Skin Analysis. It is highly recommended to use **portrait** rather than landscape aspect ratio as input.\n\n### Error Codes\n|Error Code|Description|\n| ---- | ---- |\n|error_below_min_image_size|Input image resolution is too small|\n|error_exceed_max_image_size|Input image resolution is too large|\n|error_src_face_too_small|The face area in the uploaded image is too small. The width of the face needs to be greater than 60% of the width of the image.|\n|error_src_face_out_of_bound|The face area in the uploaded image is out of bound|\n|error_lighting_dark|The lighting in the uploaded image is too dark|\n\n## JS Camera Kit\nWant to perform AI skin analysis in a browser? This camera kit lets you open your browser\u2019s camera, snap a photo, and you are ready to run an AI skin analysis API task. But if you\u2019d rather create your own version, you\u2019re free to do so! It\u2019s just a JavaScript demo for reference and isn\u2019t mandatory for using the AI Skin Analysis API.\n\n### Download the YMK JS Camera Module\nhttps://plugins-media.makeupar.com/v1.0-skincare-camera-kit/sdk.js\n\n### Demo Sample Code\nThis example html webpage demonstrates how to initialise the JavaScript CameraKit module, request camera permission from a modern browser, and then open the camera to take a suitable photo. The image can then be resized and saved, making it ready to be sent for an AI Skin Analysis task.
\n
Download link: [Skincare Camera Kit Sample - UI Mode](https://perfectcorp365-my.sharepoint.com/:u:/g/personal/aj_chou_perfectcorp_com/EfYyotTLUjRPop_BanqjbFABZkxBX_8XYmwZ_O0K6m9bjg?e=jh7U6s)\n
Download link: [Skincare Camera Kit Sample - Headless Mode](https://perfectcorp365-my.sharepoint.com/:u:/g/personal/aj_chou_perfectcorp_com/Ef__AhU80K5Crj3CJLfbbBQBpergAxzOu_Bjkhog8oM9pA)\n\n### YMK JS Camera Module API Documentation\n### Introduction\nThis document outlines the JavaScript camera module designed to capture high-quality images for integration into an AI Skin Analysis workflow. The API supports both UI Mode (with built-in camera controls and face quality indicators) and Headless Mode (API-driven without visual components), enabling flexible use cases in web applications.\n\n---\n\n### Quick Start Guide\nThe YMK JS Camera Module API provides robust tools for capturing and validating images tailored for AI analysis workflows. Use UI Mode for user-facing applications and Headless Mode for server-side integration or custom implementations. Always prioritize face quality checks before triggering captures to ensure accurate results.\n#### Prerequisites\n- A webpage with a `\n```\n\n#### UI Mode Integration\nUse this mode for applications requiring a camera preview and automatic face quality checks via predefined UI elements.\n##### Steps:\n1. **Initialize** the module (defaults to UI Mode):\n ```javascript\n YMK.init({\n width: 360,\n height: 480,\n language: \"enu\"\n });\n ```\n2. **Registering Event Handlers** See Event Handling\n3. **Open Camera** with face quality monitoring:\n ```javascript\n YMK.openSkincareCamera(); // Shows built-in UI with camera and overlays\n ```\n4. **Capture Photo** automatically when minimum requirements are met, or manually via the UI.\n5. **Close Module**:\n ```javascript\n YMK.close();\n ```\n\n#### Headless Mode Integration\nIdeal for applications needing minimal overhead (e.g., backend integration) or custom UI implementation.\n##### Steps:\n1. **Set Input Source** (optional):\n ```javascript\n YMK.setCanvasInput(\"base64\", \"data:image/png;base64...\", canvasElement);\n ```\n2. **Initialize in Headless Mode**:\n ```javascript\n YMK.init({\n moduleMode: \"headless\",\n width: 640,\n height: 480,\n snapshotType: \"base64\"\n });\n ```\n3. **Registering Event Handlers** See Event Handling\n4. **Open Specific Module**:\n ```javascript\n YMK.openSkincareCamera();\n ```\n5. **Capture A Photo**:(to be used for AI Skin Analysis task)\n ```javascript\n YMK.capture();\n ```\n6. **Close Module**:\n ```javascript\n YMK.close();\n ```\n\n---\n### API Reference\n| Method | Description | Availability |\n|-----------------------------|----------------------------------------------|-------------|\n| `YMK.init(args)` | Initializes the camera module | UI/Headless |\n| `YMK.setCanvasInput(type, source, input)`
Set input for headless mode.
When using base64 or file:
- Supported image formats: PNG, JPEG
- Supported video format: MP4
Recommended input size: Below 1080p for stability\" |* Fields of arguments *
- type: string; alternatives: [\"image\", \"video\"].
- source (required): string; alternatives: [\"base64\", \"file\", \"canvas\", \"mediaStreamTrack\"].
- input (required): base64-string / File / HTMLCanvasElement / MediaStreamTrack |Headless Mode only |\n| `YMK.capture()` | Captures a frame from the live stream | Headless Mode only |\n| `YMK.getResultCanvas()` | Retrieves an HTMLCanvasElement sized to args.width and args.height from YMK.init | Headless Mode only |\n| `YMK.flipCamera()` | Flip the camera if your device supports it | Headless Mode only |\n\n---\n\n#### Initialization (`YMK.init(args)`)\n**Parameters:**\n```javascript\n{\n width: , // Defaults to responsive based on screen size\n height: , // Defaults to window.screen.height * 0.8 for smaller screens\n moduleMode: \"ui\" or \"headless\", // Default is UI Mode (no explicit headless option in v1.x)\n snapshotType: \"base64\" or \"blob\", // Default is \"base64\" for skinAnalysisDetectionCaptured event\n language: [\"chs\", \"cht\", \"deu\", \"enu\", \"esp\", \"fra\", \"jpn\", \"kor\", \"ptb\", \"ita\"] // Defaults to \"enu\"\n}\n```\n\n### Core Methods\n```javascript\n/**\n * Starts or resumes the live stream.\n * Resumes the live stream if it was previously paused. This function works only in live mode.\n * Options:\n * - restartWebcam (boolean) \u2013 Defaults to false. Set to true to force the webcam to restart when resuming the stream.\n */\nYMK.resume(false);\n\n/**\n * Pauses the camera preview (useful for background tasks).\n */\nYMK.pause();\n\n/**\n * Closes the module entirely (stops camera and releases resources).\n */\nYMK.close();\n\n\n/**\n * See whether the live stream or photo made it onto the canvas.\n */\nYMK.isLoaded();\n\n\n/**\n * Captures a frame by pausing the live stream and triggering the skinAnalysisDetectionCaptured event to retrieve the snapshot image.\n * For best results, call YMK.capture only when face quality is sufficient\u2014meaning \"area\", \"frontal\", and \"lighting\" are all reported as \"good\" or \"ok\" via the faceQualityChanged event.\n * Alternatively, you can trigger it right after receiving the skinAnalysisDetectionCompleted event.\n * Note: Capturing with poor image quality may lead to inaccurate analysis.\n */\nYMK.capture();\n\n/**\n * Retrieves the current FPS (frames per second).\n * Returns:\n * A JavaScript object containing the latest module info at the time the API is called.\n * \u00a0\u00a0\u00a0\u00a0\u2022 fps (number) \u2013 The current frame rate. Defaults to 0 if the engine hasn\u2019t loaded yet.\n * \n */\nYMK.getInfo();\n```\n\n---\n\n\n### Event Handling\n```javascript\n// Add listener example:\nconst faceQualityListener = YMK.addEventListener(\"faceQualityChanged\", handleFaceQuality);\n\nfunction handleFaceQuality(quality) {\n console.log(\"Face Quality:\", quality);\n}\n\n// Remove listener example:\nYMK.removeEventListener(faceQualityListener); // *Note: Headless Mode uses custom event handlers*\n```\n\n### Events\n#### Common Events\n| Event Name | Triggered When | Arguments |\n|-------------------------------|----------------------------------------------|--------------------|\n| `opened` | Module UI is fully rendered | None |\n| `loading(progress: number)` | During module initialization | Progress (0-100%) |\n|`loaded`|Triggered when a live stream or photo is loaded onto the canvas.|None|\n|`closed`| YMK module closed |None|\n| `cameraOpened` | Camera hardware successfully starts | None |\n| `cameraClosed` | Camera closed |None|\n| `cameraFailed` | Accessing camera fails due to permission denial or device error | None |\n\n#### Face Quality Monitoring (`faceQualityChanged`)\n**UI Mode Only:**\n```javascript\nYMK.addEventListener(\"faceQualityChanged\", function(quality) {\n // Check minimum criteria for analysis:\n if (quality.hasFace && quality.area === \"good\" && quality.lighting >= \"ok\") {\n console.log(\"Proceed with Analysis\");\n }\n});\n```\n\n**Headless Mode Example:**\n```javascript\nYMK.addEventListener(\"faceQualityChanged\", function(quality) {\n // Handle specific property checks:\n if (!quality.hasFace) alert(\"No face detected! Keep your face inside the circle.\");\n else if (quality.area === \"outofboundary\") {\n console.log(\"Warning:\", quality.areaMessages[0]); // \"Your face is too close...\"\n }\n});\n```\n#### Module-Specific Events\n| Event Name | Description |Availability|\n|-------------------------------|-----------------------------------------------|--|\n| `faceQualityChanged(quality: object)` | Real-time face quality updates | UI/Headless |\n| `skinAnalysisDetectionStarted` | UI Mode only \u2013 Enters face quality detection page | UI Mode only |\n| `skinAnalysisDetectionCaptured` | In UI mode, this is triggered once a face is qualified and captured. In headless mode, it's triggered right after capturing with YMK.capture
Args: [image]
image: the snapshot image in base64 format or binary format (according to args.snapshotType) | UI/Headless |\n| `unsupportedResolution` | Triggered when the YMK module receives an unexpected width or height | UI Mode only |\n\n**faceQualityChanged Arguments: [quality] quality: JS Object**\n- hasFace: true, false (boolean): Determines if a face is detected. Analysis proceeds only when the value is true.\n- area: \"good\", \"notgood\", \"toosmall\", \"outofboundary\" (string): Assesses whether the user's face is positioned at an appropriate distance. Possible values:\n - \"good\" \u2013 Distance is optimal; analysis can proceed.\n - \"notgood\", \"toosmall\", \"outofboundary\" \u2013 Distance requires adjustment.\n- frontal: \"good\", \"notgood\" (string): Indicates whether the user's face is sufficiently forward-facing.\n - \"good\" \u2013 Alignment is correct; analysis can proceed.\n - \"notgood\" \u2013 Face needs to be repositioned.\n- lighting: \"good\", \"ok\", \"notgood\" (string): Evaluates whether lighting conditions are sufficient.\n - \"good\", \"ok\" \u2013 Lighting is acceptable; analysis can proceed.\n - \"notgood\" \u2013 Additional lighting may be required.\n- nakedeye: \"good\", \"notgood\" (string): Confirms if the user is not wearing eyewear. Applicable only during eyewear auto PD detection.\n - \"good\" \u2013 No eyewear detected; PD analysis can proceed.\n - \"notgood\" \u2013 Eyewear removal may be necessary.\n- faceangle \"good\", \"upward\", \"downward\", \"leftward\", \"rightward\", \"lefttilt\", \"righttilt\" (string): Measures whether the face angle is within acceptable limits. Applicable only during face analyzer detection.\n - \"good\" \u2013 Face orientation is correct; analysis can proceed.\n - \"upward\", \"downward\" \u2013 Indicates pitch angle adjustments may be needed.\n - \"leftward\", \"rightward\" \u2013 Reflects yaw angle deviations.\n - \"lefttilt\", \"righttilt\" \u2013 Represents roll angle changes (detected only when facial ratio analysis is enabled).\n\n---\n\n### Configuration Notes\n- **Quality Criteria:**\n - For skin analysis: `{ hasFace: true, area: \"good\", lighting: \"ok\" }`.\n- **Image Quality Warnings:** Always validate face quality before capturing. Use the following minimum thresholds:\n ```javascript\n const minQuality = {\n hasFace: true,\n area: \"good\",\n frontal: \"good\",\n lighting: \"ok\" // or \"good\"\n };\n ```\n- **Progressive Mode**:\n - UI Mode automatically handles quality checks via visual overlays.\n - Headless Mode requires manual validation (e.g., `YMK.capture` should only be called when faceQuality is acceptable).\n\n---\n\n### Troubleshooting\n#### Camera Access Issues\nIf you encounter an error during camera access, check the following:\n1. Ensure HTTPS or localhost for secure contexts (browser security restrictions).\n2. Request camera permissions explicitly if required by your environment.\n3. Handle `cameraFailed` event to debug permission denial errors.\n\n**Example Error Handling:**\n\n```javascript\nYMK.addEventListener(\"cameraFailed\", function() {\n alert(\"Camera access denied. Please allow permissions or use a different browser/device.\");\n});\n```\n\n---\n" }, { "name": "AI Skin Analysis", "description": "### AI Skin Analysis\n![](https://d3ss46vukfdtpo.cloudfront.net/static/media/img_demostore_skincarelive_topbanner.0cffe3a7.jpg)\nAI skincare analysis technology harnesses the power of artificial intelligence to analyze various aspects of the skin, from texture and pigmentation to hydration and pore size, with remarkable precision. By employing advanced algorithms and machine learning, AI skin analysis can offer personalized recommendations and skincare routines tailored to an individual's unique skin type and concerns.\n\nThis not only enhances the effectiveness of skincare products but also empowers users to make informed decisions about their skincare regimen. With the integration of AI skin analysis, individuals can now embark on a journey towards healthier, more radiant skin, guided by data-driven insights and the promise of more effective skincare solutions.\n\n\n## Integration Guide\n### How to Take Photos for AI Skin Analysis\n* Take a selfie facing forward\n - Just one clear shot, looking straight into the camera. Leave your hair down so it falls over your chest, and make sure you're staring directly ahead for that front-on view.\n - Instead, use the JS Camera Kit to take a photo. Just leave your hair down so it falls over your chest. Don't tie it up.\n\n### Workflow\n1. **Resize your source image**
\n Resize your photo to fit the supported dimensions - up to 1920 pixels on the long side and at least 480 pixels on the short side for SD, or up to 2560 pixels on the long side and at least 1080 pixels on the short side for HD. See details in **[File Specs & Errors](#tag/AI-Skin-Analysis/File-Specs-and-Errors)**\n\n2. **Image Upload Options**
\n - Image Requirements\n - See details in **[File Specs & Errors](#tag/AI-Skin-Analysis/File-Specs-and-Errors)**.\n You can provide the source image in one of two ways:\n\n - **Upload via File API**\n Use the endpoint:\n ```\n POST /v2.0/file/skin-analysis\n ```\n This returns a `file_id` for subsequent task execution.\n\n - ***Important***: Simply calling the File API does not upload your file. You must **manually upload** the file to the **URL provided in the File API response**. That URL is your upload destination, make sure the file is successfully transferred there before proceeding.

\n Before calling the AI API, ensure your file has been successfully uploaded. Use the File API to retrieve an upload URL, then upload your file to that location. Once the upload is complete, you'll receive a ***file_id*** in the response, this ID is what you'll use to access AI features related to that file.\n\n > **Warning:** Please note that, you will get an 500 Server Error / unknown_internal_error or 404 Not Found error when using AI APIs if you do not upload the file to the URL provided in the File API response.\n\n - **Use an Existing Public Image URL**\n Instead of uploading, you may supply a publicly accessible image URL directly when initiating the AI task.\n\n3. **Run an AI Skin Analysis task**
\n Once the upload is complete, you can select 4, 7, or 14 skin concerns to analyze using your file ID or image file url. Please refer to the **[Inputs & Outputs](#tag/AI-Skin-Analysis/Inputs-and-Outputs)**.
\n Subsequently, calling POST 'task/skin-analysis' with the\n File ID or image file url executes the enhance task and obtains a ***task_id***.\n\n4. **Get the result of an AI task once success**
\n This ***task_id*** is used to monitor the task's status through polling GET 'task/skin-analysis' to retrieve the current engine status. Until the engine completes the task, the status will remain 'running', and no units will be consumed during this stage.

\n Processed results are retained for 24 hours after completion.- No need for short-interval polling.- Flexible polling intervals within the 24-hour window.- Important: Polling is still required to check task status, as execution time is not guaranteed.

\n The task will change to the 'success' status after the engine successfully processes your input file and generates the resulting image. You will get an url of the processed image and a dst_id that allow you to chain another AI task without re-upload the result image.\n Your units will only be consumed in this case. If the engine fails to process the task, the task's status will change to 'error' and no unit will be consumed.
\n When deducting units, the system will prioritize those nearing expiration. If the expiration date is the same, it will deduct the units obtained on the earliest date.\n\n### Debugging Guide\n> **Warning:** Please be advised that the system requires processing **exactly 4, 7, or 14** distinct skin concerns at one time. Simultaneous use of SD and HD skin concern parameters is **NOT** supported. Attempting to deviate from these specifications will result in an ***InvalidParameters*** error.\n\n * For example, if you run a task with 5 HD skin concerns, you will get an error as following:\n ```json\n {\n \"status\": 400,\n \"error\": \"must select 4, 7 or 14 distinct dst_actions\",\n \"error_code\": \"InvalidParameters\"\n }\n ```\n * If you mix using HD and SD skin concerns, you will get an error as following:\n ```json\n {\n \"status\": 400,\n \"error\": \"cannot mix HD and SD dst_actions\",\n \"error_code\": \"InvalidParameters\"\n }\n ```\n * If you misspell a skin concern or sending unknown skin concerns, you will get an error as following:\n ```json\n {\n \"status\": 400,\n \"error\": \"Not available dst_action abc123\",\n \"error_code\": \"InvalidParameters\"\n }\n ```\n\n---\n\n### Real-world examples:\n![](https://plugins-media.makeupar.com/webconsultation/images/skincare-widget/img_webcm_skincare_service_survey_demo.jpg)\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/skin_analysis_s5_poster_3_dt_85efe14952.png)\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/Skincare_Pro_Medspa_Situation_Image_6aea6046f9.jpg)\n\n## Inputs & Outputs\n### Suggestions for How to Shoot:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/strapi/assets/webp_AI%20Skin%20Analysis_camera_f93315b088.png)\n\n> **Warning:** The width of the face needs to be greater than 60% of the width of the image.\n\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/strapi/assets/webp_AI%20Skin%20Analysis_error_src_face_too_small_cr_725792a7fb.png)\n\n### Get Ready to Start Skin Analysis Instructions\n* Take off your glasses and make sure bangs are not covering your forehead\n* Make sure that you\u2019re in a well-lit environment\n* Remove makeup to get more accurate results\n* Look straight into the camera and keep your face in the center\n\n### Output ZIP Data Structure Description\nThe system provides a ZIP file with a 'skinanalysisResult' folder inside. This folder contains a 'score_info.json' file that includes all the detection scores and references to the result images.\n\nThe 'score_info.json' file contains all the skin analysis detection results, with numerical scores and the names of the corresponding output mask files.\n\nThe PNG files are detection result masks that can be overlaid on your original image. Simply use the alpha values in these PNG files to blend them with your original image, allowing you to see the detection results directly on the source image.\n\n### File Structure in the Skin Analysis Result ZIP\n* HD Skincare ZIP\n * skinanalysisResult\n - score_info.json\n - hd_acne_output.png\n - hd_age_spot_output.png\n - hd_dark_circle_output.png\n - hd_droopy_lower_eyelid_output.png\n - hd_droopy_upper_eyelid_output.png\n - hd_eye_bag_output.png\n - hd_firmness_output.png\n - hd_moisture_output.png\n - hd_oiliness_output.png\n - hd_radiance_output.png\n - hd_redness_output.png\n - hd_texture_output.png\n - hd_pore_output_all.png\n - hd_pore_output_cheek.png\n - hd_pore_output_forehead.png\n - hd_pore_output_nose.png\n - hd_wrinkle_output_all.png\n - hd_wrinkle_output_crowfeet.png\n - hd_wrinkle_output_forehead.png\n - hd_wrinkle_output_glabellar.png\n - hd_wrinkle_output_marionette.png\n - hd_wrinkle_output_nasolabial.png\n - hd_wrinkle_output_periocular.png\n\n* SD Skincare ZIP\n * skinanalysisResult\n - score_info.json\n - acne_output.png\n - age_spot_output.png\n - dark_circle_v2_output.png\n - droopy_lower_eyelid_output.png\n - droopy_upper_eyelid_output.png\n - eye_bag_output.png\n - firmness_output.png\n - moisture_output.png\n - oiliness_output.png\n - pore_output.png\n - radiance_output.png\n - redness_output.png\n - texture_output.png\n - wrinkle_output.png\n\n* JSON Data Structure (score_info.json)\n * \"all\": A floating-point value between 1 and 100 representing the general skin condition. A higher score indicates healthier and more aesthetically pleasing skin condition.\n * \"skin_age\": AI-derived skin age relative to the general population distribution across all age groups.\n * Each category contains:\n * \"raw_score\": A floating-point value ranging from 1 to 100. A higher score indicates healthier and more aesthetically pleasing skin condition.\n * \"ui_score\": An integer ranging from 1 to 100. The UI Score functions primarily as a psychological motivator in beauty assessment. We adjust the raw scores to produce more favorable results, acknowledging that consumers generally prefer positive evaluations regarding their skin health. This calibration serves to instill greater confidence in users while maintaining the underlying beauty psychology framework.\n * \"output_mask_name\": The filename of the corresponding output mask image.\n\n * Categories and Descriptions\n * HD Skincare:\n * \"hd_redness\": Measures skin redness severity.\n * \"hd_oiliness\": Determines skin oiliness level.\n * \"hd_age_spot\": Detects age spots and pigmentation.\n * \"hd_radiance\": Evaluates skin radiance.\n * \"hd_moisture\": Assesses skin hydration levels.\n * \"hd_dark_circle\": Analyzes the presence of dark circles under the eyes.\n * \"hd_eye_bag\": Detects eye bags.\n * \"hd_droopy_upper_eyelid\": Measures upper eyelid drooping severity.\n * \"hd_droopy_lower_eyelid\": Measures lower eyelid drooping severity.\n * \"hd_firmness\": Evaluates skin firmness and elasticity.\n * \"hd_texture\": Subcategories[whole]; Analyzes overall skin texture.\n * \"hd_acne\": Subcategories[whole]; Detects acne presence.\n * \"hd_pore\": Subcategories[forehead, nose, cheek, whole]; Detects and evaluates pores in different facial regions.\n * \"hd_wrinkle\": Subcategories[forehead, glabellar, crowfeet, periocular, nasolabial, marionette, whole]; Measures the severity of wrinkles in various facial areas.\n\n * SD Skincare:\n * \"wrinkle\": General wrinkle analysis.\n * \"droopy_upper_eyelid\": Measures upper eyelid drooping severity.\n * \"droopy_lower_eyelid\": Measures lower eyelid drooping severity.\n * \"firmness\": Evaluates skin firmness and elasticity.\n * \"acne\": Evaluates acne presence.\n * \"moisture\": Measures skin hydration.\n * \"eye_bag\": Detects eye bags.\n * \"dark_circle_v2\": Analyzes dark circles using an alternative method.\n * \"age_spot\": Detects age spots.\n * \"radiance\": Evaluates skin brightness.\n * \"redness\": Measures skin redness.\n * \"oiliness\": Determines skin oiliness.\n * \"pore\": Measures pore visibility.\n * \"texture\": Analyzes overall skin texture.\n\n * Sample score_info.json of HD Skincare\n ```json\n {\n \"hd_redness\": {\n \"raw_score\": 72.011962890625,\n \"ui_score\": 77,\n \"output_mask_name\": \"hd_redness_output.png\"\n },\n \"hd_oiliness\": {\n \"raw_score\": 60.74365234375,\n \"ui_score\": 72,\n \"output_mask_name\": \"hd_oiliness_output.png\"\n },\n \"hd_age_spot\": {\n \"raw_score\": 83.23274230957031,\n \"ui_score\": 77,\n \"output_mask_name\": \"hd_age_spot_output.png\"\n },\n \"hd_radiance\": {\n \"raw_score\": 76.57244205474854,\n \"ui_score\": 79,\n \"output_mask_name\": \"hd_radiance_output.png\"\n },\n \"hd_moisture\": {\n \"raw_score\": 48.694559931755066,\n \"ui_score\": 70,\n \"output_mask_name\": \"hd_moisture_output.png\"\n },\n \"hd_dark_circle\": {\n \"raw_score\": 80.1993191242218,\n \"ui_score\": 76,\n \"output_mask_name\": \"hd_dark_circle_output.png\"\n },\n \"hd_eye_bag\": {\n \"raw_score\": 76.67280435562134,\n \"ui_score\": 79,\n \"output_mask_name\": \"hd_eye_bag_output.png\"\n },\n \"hd_droopy_upper_eyelid\": {\n \"raw_score\": 79.05348539352417,\n \"ui_score\": 80,\n \"output_mask_name\": \"hd_droopy_upper_eyelid_output.png\"\n },\n \"hd_droopy_lower_eyelid\": {\n \"raw_score\": 79.97175455093384,\n \"ui_score\": 81,\n \"output_mask_name\": \"hd_droopy_lower_eyelid_output.png\"\n },\n \"hd_firmness\": {\n \"raw_score\": 89.66898322105408,\n \"ui_score\": 85,\n \"output_mask_name\": \"hd_firmness_output.png\"\n },\n \"hd_texture\": {\n \"whole\": {\n \"raw_score\": 66.3921568627451,\n \"ui_score\": 75,\n \"output_mask_name\": \"hd_texture_output.png\"\n }\n },\n \"hd_acne\": {\n \"whole\": {\n \"raw_score\": 59.92677688598633,\n \"ui_score\": 76,\n \"output_mask_name\": \"hd_acne_output.png\"\n }\n },\n \"hd_pore\": {\n \"forehead\": {\n \"raw_score\": 79.59770965576172,\n \"ui_score\": 80,\n \"output_mask_name\": \"hd_pore_output_forehead.png\"\n },\n \"nose\": {\n \"raw_score\": 29.139814376831055,\n \"ui_score\": 58,\n \"output_mask_name\": \"hd_pore_output_nose.png\"\n },\n \"cheek\": {\n \"raw_score\": 44.11081314086914,\n \"ui_score\": 65,\n \"output_mask_name\": \"hd_pore_output_cheek.png\"\n },\n \"whole\": {\n \"raw_score\": 49.23978805541992,\n \"ui_score\": 67,\n \"output_mask_name\": \"hd_pore_output_all.png\"\n }\n },\n \"hd_wrinkle\": {\n \"forehead\": {\n \"raw_score\": 55.96956729888916,\n \"ui_score\": 67,\n \"output_mask_name\": \"hd_wrinkle_output_forehead.png\"\n },\n \"glabellar\": {\n \"raw_score\": 76.7251181602478,\n \"ui_score\": 75,\n \"output_mask_name\": \"hd_wrinkle_output_glabellar.png\"\n },\n \"crowfeet\": {\n \"raw_score\": 83.4361481666565,\n \"ui_score\": 78,\n \"output_mask_name\": \"hd_wrinkle_output_crowfeet.png\"\n },\n \"periocular\": {\n \"raw_score\": 67.88706302642822,\n \"ui_score\": 72,\n \"output_mask_name\": \"hd_wrinkle_output_periocular.png\"\n },\n \"nasolabial\": {\n \"raw_score\": 74.03312683105469,\n \"ui_score\": 74,\n \"output_mask_name\": \"hd_wrinkle_output_nasolabial.png\"\n },\n \"marionette\": {\n \"raw_score\": 71.94477319717407,\n \"ui_score\": 73,\n \"output_mask_name\": \"hd_wrinkle_output_marionette.png\"\n },\n \"whole\": {\n \"raw_score\": 49.64699745178223,\n \"ui_score\": 65,\n \"output_mask_name\": \"hd_wrinkle_output_all.png\"\n }\n },\n \"all\": {\n \"score\": 75.75757575757575\n },\n \"skin_age\": 37\n }\n ```\n * Sample score_info.json of SD Skincare\n ```json\n {\n \"wrinkle\": {\n \"raw_score\": 36.09360456466675,\n \"ui_score\": 60,\n \"output_mask_name\": \"wrinkle_output.png\"\n },\n \"droopy_upper_eyelid\": {\n \"raw_score\": 79.05348539352417,\n \"ui_score\": 80,\n \"output_mask_name\": \"droopy_upper_eyelid_output.png\"\n },\n \"droopy_lower_eyelid\": {\n \"raw_score\": 79.97175455093384,\n \"ui_score\": 81,\n \"output_mask_name\": \"droopy_lower_eyelid_output.png\"\n },\n \"firmness\": {\n \"raw_score\": 89.66898322105408,\n \"ui_score\": 85,\n \"output_mask_name\": \"firmness_output.png\"\n },\n \"acne\": {\n \"raw_score\": 92.29713000000001,\n \"ui_score\": 88,\n \"output_mask_name\": \"acne_output.png\"\n },\n \"moisture\": {\n \"raw_score\": 48.694559931755066,\n \"ui_score\": 70,\n \"output_mask_name\": \"moisture_output.png\"\n },\n \"eye_bag\": {\n \"raw_score\": 76.67280435562134,\n \"ui_score\": 79,\n \"output_mask_name\": \"eye_bag_output.png\"\n },\n \"dark_circle_v2\": {\n \"raw_score\": 80.1993191242218,\n \"ui_score\": 76,\n \"output_mask_name\": \"dark_circle_v2_output.png\"\n },\n \"age_spot\": {\n \"raw_score\": 83.23274230957031,\n \"ui_score\": 77,\n \"output_mask_name\": \"age_spot_output.png\"\n },\n \"radiance\": {\n \"raw_score\": 76.57244205474854,\n \"ui_score\": 79,\n \"output_mask_name\": \"radiance_output.png\"\n },\n \"redness\": {\n \"raw_score\": 72.011962890625,\n \"ui_score\": 77,\n \"output_mask_name\": \"redness_output.png\"\n },\n \"oiliness\": {\n \"raw_score\": 60.74365234375,\n \"ui_score\": 72,\n \"output_mask_name\": \"oiliness_output.png\"\n },\n \"pore\": {\n \"raw_score\": 88.38014125823975,\n \"ui_score\": 84,\n \"output_mask_name\": \"pore_output.png\"\n },\n \"texture\": {\n \"raw_score\": 80.09742498397827,\n \"ui_score\": 76,\n \"output_mask_name\": \"texture_output.png\"\n },\n \"all\": {\n \"score\": 75.75757575757575\n },\n \"skin_age\": 37\n }\n ```\n\n## File Specs & Errors\n### Supported Formats & Dimensions\n|AI Feature|Supported Dimensions|Supported File Size|Supported Formats|\n| ---- | ---- | ---- | ---- |\n|SD Skincare|**long side <= 1920, short side >= 480**|< 10MB|jpg/jpeg/png|\n|HD Skincare|**long side <= 2560, short side >= 1080**|< 10MB|jpg/jpeg/png|\n\n> **Warning:** It is your resposibility to resize input images based on the ***Supported Dimensions*** of HD or SD Skincare before runing AI Skin Analysis. It is highly recommended to use **portrait** rather than landscape aspect ratio as input.\n\n### Error Codes\n|Error Code|Description|\n| ---- | ---- |\n|error_below_min_image_size|Input image resolution is too small|\n|error_exceed_max_image_size|Input image resolution is too large|\n|error_src_face_too_small|The face area in the uploaded image is too small. The width of the face needs to be greater than 60% of the width of the image.|\n|error_src_face_out_of_bound|The face area in the uploaded image is out of bound|\n|error_lighting_dark|The lighting in the uploaded image is too dark|\n\n### Environment & Dependency\n| Sample Code Language / Tool | Recommended Runtime Versions |\n|---|---|\n| cURL | cURL 8.x |\n| Node.js (JavaScript) | Node.js 18.x/20.x LTS |\n| JavaScript | Compatible with Chromium v100 |\n| PHP | PHP 8.1+ |\n| Python | Python 3.10+ |\n| Java | JDK 1.8 or 21 LTS |\n\n## JS Camera Kit\nWant to perform AI skin analysis in a browser? This camera kit lets you open your browser\u2019s camera, snap a photo, and you are ready to run an AI skin analysis API task. But if you\u2019d rather create your own version, you\u2019re free to do so! It\u2019s just a JavaScript demo for reference and isn\u2019t mandatory for using the AI Skin Analysis API.\n\n### Download the YMK JS Camera Module\nhttps://plugins-media.makeupar.com/v1.0-skincare-camera-kit/sdk.js\n\n### Demo Sample Code\nThis example html webpage demonstrates how to initialise the JavaScript CameraKit module, request camera permission from a modern browser, and then open the camera to take a suitable photo. The image can then be resized and saved, making it ready to be sent for an AI Skin Analysis task.
\n
Download link: [Skincare Camera Kit Sample - UI Mode](https://perfectcorp365-my.sharepoint.com/:u:/g/personal/aj_chou_perfectcorp_com/EfYyotTLUjRPop_BanqjbFABZkxBX_8XYmwZ_O0K6m9bjg?e=jh7U6s)\n
Download link: [Skincare Camera Kit Sample - Headless Mode](https://perfectcorp365-my.sharepoint.com/:u:/g/personal/aj_chou_perfectcorp_com/Ef__AhU80K5Crj3CJLfbbBQBpergAxzOu_Bjkhog8oM9pA)\n\n### YMK JS Camera Module API Documentation\n### Introduction\nThis document outlines the JavaScript camera module designed to capture high-quality images for integration into an AI Skin Analysis workflow. The API supports both UI Mode (with built-in camera controls and face quality indicators) and Headless Mode (API-driven without visual components), enabling flexible use cases in web applications.\n\n---\n\n### Quick Start Guide\nThe YMK JS Camera Module API provides robust tools for capturing and validating images tailored for AI analysis workflows. Use UI Mode for user-facing applications and Headless Mode for server-side integration or custom implementations. Always prioritize face quality checks before triggering captures to ensure accurate results.\n#### Prerequisites\n- A webpage with a `\n```\n\n#### UI Mode Integration\nUse this mode for applications requiring a camera preview and automatic face quality checks via predefined UI elements.\n##### Steps:\n1. **Initialize** the module (defaults to UI Mode):\n ```javascript\n YMK.init({\n width: 360,\n height: 480,\n language: \"enu\"\n });\n ```\n2. **Registering Event Handlers** See Event Handling\n3. **Open Camera** with face quality monitoring:\n ```javascript\n YMK.openSkincareCamera(); // Shows built-in UI with camera and overlays\n ```\n4. **Capture Photo** automatically when minimum requirements are met, or manually via the UI.\n5. **Close Module**:\n ```javascript\n YMK.close();\n ```\n\n#### Headless Mode Integration\nIdeal for applications needing minimal overhead (e.g., backend integration) or custom UI implementation.\n##### Steps:\n1. **Set Input Source** (optional):\n ```javascript\n YMK.setCanvasInput(\"base64\", \"data:image/png;base64...\", canvasElement);\n ```\n2. **Initialize in Headless Mode**:\n ```javascript\n YMK.init({\n moduleMode: \"headless\",\n width: 640,\n height: 480,\n snapshotType: \"base64\"\n });\n ```\n3. **Registering Event Handlers** See Event Handling\n4. **Open Specific Module**:\n ```javascript\n YMK.openSkincareCamera();\n ```\n5. **Capture A Photo**:(to be used for AI Skin Analysis task)\n ```javascript\n YMK.capture();\n ```\n6. **Close Module**:\n ```javascript\n YMK.close();\n ```\n\n---\n### API Reference\n| Method | Description | Availability |\n|-----------------------------|----------------------------------------------|-------------|\n| `YMK.init(args)` | Initializes the camera module | UI/Headless |\n| `YMK.setCanvasInput(type, source, input)`
Set input for headless mode.
When using base64 or file:
- Supported image formats: PNG, JPEG
- Supported video format: MP4
Recommended input size: Below 1080p for stability\" |* Fields of arguments *
- type: string; alternatives: [\"image\", \"video\"].
- source (required): string; alternatives: [\"base64\", \"file\", \"canvas\", \"mediaStreamTrack\"].
- input (required): base64-string / File / HTMLCanvasElement / MediaStreamTrack |Headless Mode only |\n| `YMK.capture()` | Captures a frame from the live stream | Headless Mode only |\n| `YMK.getResultCanvas()` | Retrieves an HTMLCanvasElement sized to args.width and args.height from YMK.init | Headless Mode only |\n| `YMK.flipCamera()` | Flip the camera if your device supports it | Headless Mode only |\n\n---\n\n#### Initialization (`YMK.init(args)`)\n**Parameters:**\n```javascript\n{\n width: , // Defaults to responsive based on screen size\n height: , // Defaults to window.screen.height * 0.8 for smaller screens\n moduleMode: \"ui\" or \"headless\", // Default is UI Mode (no explicit headless option in v1.x)\n snapshotType: \"base64\" or \"blob\", // Default is \"base64\" for skinAnalysisDetectionCaptured event\n language: [\"chs\", \"cht\", \"deu\", \"enu\", \"esp\", \"fra\", \"jpn\", \"kor\", \"ptb\", \"ita\"] // Defaults to \"enu\"\n}\n```\n\n### Core Methods\n```javascript\n/**\n * Starts or resumes the live stream.\n * Resumes the live stream if it was previously paused. This function works only in live mode.\n * Options:\n * - restartWebcam (boolean) \u2013 Defaults to false. Set to true to force the webcam to restart when resuming the stream.\n */\nYMK.resume(false);\n\n/**\n * Pauses the camera preview (useful for background tasks).\n */\nYMK.pause();\n\n/**\n * Closes the module entirely (stops camera and releases resources).\n */\nYMK.close();\n\n\n/**\n * See whether the live stream or photo made it onto the canvas.\n */\nYMK.isLoaded();\n\n\n/**\n * Captures a frame by pausing the live stream and triggering the skinAnalysisDetectionCaptured event to retrieve the snapshot image.\n * For best results, call YMK.capture only when face quality is sufficient\u2014meaning \"area\", \"frontal\", and \"lighting\" are all reported as \"good\" or \"ok\" via the faceQualityChanged event.\n * Alternatively, you can trigger it right after receiving the skinAnalysisDetectionCompleted event.\n * Note: Capturing with poor image quality may lead to inaccurate analysis.\n */\nYMK.capture();\n\n/**\n * Retrieves the current FPS (frames per second).\n * Returns:\n * A JavaScript object containing the latest module info at the time the API is called.\n * \u00a0\u00a0\u00a0\u00a0\u2022 fps (number) \u2013 The current frame rate. Defaults to 0 if the engine hasn\u2019t loaded yet.\n * \n */\nYMK.getInfo();\n```\n\n---\n\n\n### Event Handling\n```javascript\n// Add listener example:\nconst faceQualityListener = YMK.addEventListener(\"faceQualityChanged\", handleFaceQuality);\n\nfunction handleFaceQuality(quality) {\n console.log(\"Face Quality:\", quality);\n}\n\n// Remove listener example:\nYMK.removeEventListener(faceQualityListener); // *Note: Headless Mode uses custom event handlers*\n```\n\n### Events\n#### Common Events\n| Event Name | Triggered When | Arguments |\n|-------------------------------|----------------------------------------------|--------------------|\n| `opened` | Module UI is fully rendered | None |\n| `loading(progress: number)` | During module initialization | Progress (0-100%) |\n|`loaded`|Triggered when a live stream or photo is loaded onto the canvas.|None|\n|`closed`| YMK module closed |None|\n| `cameraOpened` | Camera hardware successfully starts | None |\n| `cameraClosed` | Camera closed |None|\n| `cameraFailed` | Accessing camera fails due to permission denial or device error | None |\n\n#### Face Quality Monitoring (`faceQualityChanged`)\n**UI Mode Only:**\n```javascript\nYMK.addEventListener(\"faceQualityChanged\", function(quality) {\n // Check minimum criteria for analysis:\n if (quality.hasFace && quality.area === \"good\" && quality.lighting >= \"ok\") {\n console.log(\"Proceed with Analysis\");\n }\n});\n```\n\n**Headless Mode Example:**\n```javascript\nYMK.addEventListener(\"faceQualityChanged\", function(quality) {\n // Handle specific property checks:\n if (!quality.hasFace) alert(\"No face detected! Keep your face inside the circle.\");\n else if (quality.area === \"outofboundary\") {\n console.log(\"Warning:\", quality.areaMessages[0]); // \"Your face is too close...\"\n }\n});\n```\n#### Module-Specific Events\n| Event Name | Description |Availability|\n|-------------------------------|-----------------------------------------------|--|\n| `faceQualityChanged(quality: object)` | Real-time face quality updates | UI/Headless |\n| `skinAnalysisDetectionStarted` | UI Mode only \u2013 Enters face quality detection page | UI Mode only |\n| `skinAnalysisDetectionCaptured` | In UI mode, this is triggered once a face is qualified and captured. In headless mode, it's triggered right after capturing with YMK.capture
Args: [image]
image: the snapshot image in base64 format or binary format (according to args.snapshotType) | UI/Headless |\n| `unsupportedResolution` | Triggered when the YMK module receives an unexpected width or height | UI Mode only |\n\n**faceQualityChanged Arguments: [quality] quality: JS Object**\n- hasFace: true, false (boolean): Determines if a face is detected. Analysis proceeds only when the value is true.\n- area: \"good\", \"notgood\", \"toosmall\", \"outofboundary\" (string): Assesses whether the user's face is positioned at an appropriate distance. Possible values:\n - \"good\" \u2013 Distance is optimal; analysis can proceed.\n - \"notgood\", \"toosmall\", \"outofboundary\" \u2013 Distance requires adjustment.\n- frontal: \"good\", \"notgood\" (string): Indicates whether the user's face is sufficiently forward-facing.\n - \"good\" \u2013 Alignment is correct; analysis can proceed.\n - \"notgood\" \u2013 Face needs to be repositioned.\n- lighting: \"good\", \"ok\", \"notgood\" (string): Evaluates whether lighting conditions are sufficient.\n - \"good\", \"ok\" \u2013 Lighting is acceptable; analysis can proceed.\n - \"notgood\" \u2013 Additional lighting may be required.\n- nakedeye: \"good\", \"notgood\" (string): Confirms if the user is not wearing eyewear. Applicable only during eyewear auto PD detection.\n - \"good\" \u2013 No eyewear detected; PD analysis can proceed.\n - \"notgood\" \u2013 Eyewear removal may be necessary.\n- faceangle \"good\", \"upward\", \"downward\", \"leftward\", \"rightward\", \"lefttilt\", \"righttilt\" (string): Measures whether the face angle is within acceptable limits. Applicable only during face analyzer detection.\n - \"good\" \u2013 Face orientation is correct; analysis can proceed.\n - \"upward\", \"downward\" \u2013 Indicates pitch angle adjustments may be needed.\n - \"leftward\", \"rightward\" \u2013 Reflects yaw angle deviations.\n - \"lefttilt\", \"righttilt\" \u2013 Represents roll angle changes (detected only when facial ratio analysis is enabled).\n\n---\n\n### Configuration Notes\n- **Quality Criteria:**\n - For skin analysis: `{ hasFace: true, area: \"good\", lighting: \"ok\" }`.\n- **Image Quality Warnings:** Always validate face quality before capturing. Use the following minimum thresholds:\n ```javascript\n const minQuality = {\n hasFace: true,\n area: \"good\",\n frontal: \"good\",\n lighting: \"ok\" // or \"good\"\n };\n ```\n- **Progressive Mode**:\n - UI Mode automatically handles quality checks via visual overlays.\n - Headless Mode requires manual validation (e.g., `YMK.capture` should only be called when faceQuality is acceptable).\n\n---\n\n### Troubleshooting\n#### Camera Access Issues\nIf you encounter an error during camera access, check the following:\n1. Ensure HTTPS or localhost for secure contexts (browser security restrictions).\n2. Request camera permissions explicitly if required by your environment.\n3. Handle `cameraFailed` event to debug permission denial errors.\n\n**Example Error Handling:**\n\n```javascript\nYMK.addEventListener(\"cameraFailed\", function() {\n alert(\"Camera access denied. Please allow permissions or use a different browser/device.\");\n});\n```\n\n---\n" }, { "name": "AI Image to Video Generator", "description": "### AI Image to Video Generator\nYouCam AI Image to Video Generator quickly turns one image into stunning videos using advanced algorithms to create realistic motion effects. Offers a variety of highly optimized pre-made templates to animate your photos.\n\nTo easily create a video from an image using AI, start with a photo that has a clean background and a clear portrait. Simply upload your photo, and watch the magic happen!\n\nUse cases:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/strapi/assets/webp_Animate%20Photo_047_d9e1cff579.jpg)\n\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/AI_Dance_Video_61cf4c58d1.png)\n\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/241216_AI_Kiss_image05_c3b7f1ac5b.jpg)\n\n\nSuggestions for How to Shoot:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/AI_Hair_Extension_recommendation_ba24bd5d92.png)\n\n### Supported Formats & Dimensions\n|AI Feature|Supported Dimensions|Supported File Size|Supported Formats|\n| ---- | ---- | ---- | ---- |\n|Image to Video (Standard)|Input: >= 300*300px with aspect ratio between 1:2.5 ~ 2.5:1. Output: Up to 720p 30fps|Input: <10MB. Output: 5 seconds or 10 seconds|jpg/jpeg/png|\n|Image to Video (Professional)|Input: >= 300*300px with aspect ratio between 1:2.5 ~ 2.5:1. Output: Up to 1080p 30fps|Input: <10MB. Output: 5 seconds or 10 seconds|jpg/jpeg/png|\n\n### Error Codes\n|Error Message|Description|\n| ---- | ---- |\n|Invalid request parameters\t|Check whether the request parameters are correct\n|Invalid parameters, such as incorrect key or illegal value\t|Refer to the specific information in the message field of the returned body and modify the request parameters\n|The requested method is invalid\t|Review the API documentation and use the correct request method\n|The requested resource does not exist, such as the model\t|Refer to the specific information in the message field of the returned body and modify the request parameters\n|Trigger strategy of the platform\t|Check if any platform policies have been triggered\n|Trigger the content security policy of the platform\t|Check the input content, modify it, and resend the request\n|Server internal error\t|Try again later, or contact customer service\n|Server temporarily unavailable, usually due to maintenance\t|Try again later, or contact customer service\n|Server internal timeout, usually due to a backlog\t|Try again later, or contact customer service\n" }, { "name": "AI Clothes V1", "description": "### AI Clothes\nAI Clothes is a virtual fitting room that lets users try on clothes without physically wearing them. Using AI and photo editing technology, these apps overlay outfits onto your image so you can see how different styles and fits look on your body type. It\u2019s perfect for online shopping, style inspiration, or just playing around with fashion ideas. Try on clothes virtually with AI Clothes . Upload any clothing reference to swap outfits with you photo for an instant virtual wardrobe transformation.\n\n## Integration Guide\n### Try-On Predefined Styles\n1. **Upload file using the File API**
\n Using the ***v1.1/file/cloth*** API to upload a target user image.\n - Image Requirements\n - See details in **[File Specs & Errors](#tag/AI-Clothes/File-Specs-and-Errors)**.\n - Upload a full body photo of yourself. The virtual outfit changer works best with high resolution photos that show your clothes clearly. The photo background should not have too many people or distracting objects.\n\n2. **List Predefined Outfit Styles**
\n There are two ways to list outfits for AI Clothes virtual try-on:\n - ***v1.0/task/style-group/cloth*** and ***v1.0/task/style/cloth***: Retrieve style groups first, then fetch styles within the chosen group.\n - ***v1.1/task/style/cloth***: Fetch a predefined style list by category. If you don\u2019t specify a category_id, each category will contain either styles or subcategories. Categories with a single layer only include styles, while multi-layered categories will have subcategories. To explore a subcategory, pass its ID as category_id and call the list again.\n\n3. **Run an AI task to obtain it's task_id**
\n Execute AI task ***v1.0/task/cloth*** with the clothing image file_id as ref_ids and the target user image file_id as src_ids.\n\n4. **Polling to check the status of a task until it succeed or error**
\n This ***task_id*** is used to monitor the task's status through polling GET 'v1.0/task/cloth' to retrieve the current engine status. Until the engine completes the task, the status will remain 'running', and no units will be consumed during this stage.\n\n **Warning:** Please note that, **Polling** to check the status of a task based on it's ***polling_interval*** is mandotary. A task will be timed out if there is no polling request within the ***polling_interval***, even if the task is processed succefully(Your unit(s) will be consumed).\n\n > **Warning:** You will get a ***InvalidTaskId*** error once you check the status of a timed out task. So, once you run an AI task, you need to **polling** to check the status within the ***polling_interval*** until the status become either *success* or *error*.\n\n5. **Get the result of an AI task once success**
\n The task will change to the 'success' status after the engine successfully processes your input file and generates the resulting image. You will get an url of the processed image and a dst_id that allow you to chain another AI task without re-upload the result image.\n\n### For Custom Clothing Virtual Try-On\n1. **Upload file using the File API**
\n Image Requirements\n - See details in **[File Specs & Errors](#tag/AI-Clothes/File-Specs-and-Errors)**.\n\n Using the ***v1.1/file/cloth*** API, please upload the following assets:\n - A reference image of the clothing\n - A full-body photo to serve as the virtual try-on target\n\n2. **Run an AI task to obtain it's task_id**
\n Execute AI task ***v1.0/task/cloth*** with the clothing image file_id as ref_ids and the target user image file_id as src_ids.\n * To ensure the best results, please follow these requirements:\n * Match Clothing Type to Selected Body Area\n - When selecting Upper Body, the garment must be a top.\n - When selecting Lower Body, the garment must be pants or a skirt.\n - For Dresses or Full-Body Outfits, select Full Body \u2014 not upper or lower body individually.\n\n > **Warning:** Note on Try-On Region Conflicts\n If there's a mismatch between the selected try-on region and the uploaded clothing image, the system will default to the region defined by the clothing image.\n Example: If you select \"Full Body\" but upload an upper-body-only garment, only the upper body will be applied.\n\n > **Warning:** You need to ensure that your source image includes the necessary body part for the virtual clothing to be applied; otherwise, an ***error_apply_region_mismatch*** error will be triggered.\n\n > **Warning:** If the chosen clothing style doesn\u2019t match the body area selected for application, the system prioritizes the clothing image to determine where it will be applied. For example, if a user chooses to apply clothing to the whole body but uploads an image of only the upper body, the clothing will be applied only to the upper body.\n\n3. **Polling to check the status of a task until it succeed or error**
\n This ***task_id*** is used to monitor the task's status through polling GET 'v1.0/task/cloth' to retrieve the current engine status. Until the engine completes the task, the status will remain 'running', and no units will be consumed during this stage.\n\n **Warning:** Please note that, **Polling** to check the status of a task based on it's ***polling_interval*** is mandotary. A task will be timed out if there is no polling request within the ***polling_interval***, even if the task is processed succefully(Your unit(s) will be consumed).\n\n > **Warning:** You will get a ***InvalidTaskId*** error once you check the status of a timed out task. So, once you run an AI task, you need to **polling** to check the status within the ***polling_interval*** until the status become either *success* or *error*.\n\n4. **Get the result of an AI task once success**
\n The task will change to the 'success' status after the engine successfully processes your input file and generates the resulting image. You will get an url of the processed image and a dst_id that allow you to chain another AI task without re-upload the result image.\n\nUse cases:\n![](https://plugins-media.makeupar.com/smb/blog/post/2025-05-08/b80f4ae1-c905-4ec0-b491-e42c15e65575.gif)\n\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/strapi/assets/01%20ai%20clothes%20changer.jpg)\n\n![](https://plugins-media.makeupar.com/smb/blog/post/2023-12-01/45f451aa-4b4f-466d-9da7-4538573c92af.jpg)\n\nSuggestions for How to Shoot:\n![Suggestions for How to Shoot](https://bcw-media.s3.ap-northeast-1.amazonaws.com/strapi/assets/AI-Cloth-Guideline.png \"Suggestions for How to Shoot\")\n\n\n## File Specs & Errors\n### Supported Formats & Dimensions\n|Type|Supported Dimensions|Supported File Size|Supported Formats|\n| ---- | ---- | ---- | ---- |\n|Target user image|1024\u00d7768 recommended, 512\u00d7384 minimum, max side 4096 px.

- Single person only.
- The person should occupy at least 80% of the frame for optimal results.
- The image must show the abdomen to face, including shoulders.
- The face must be fully visible, with no obstructions.
- The body must be facing forward in a standing position (no sitting or crouching). |< 10MB|jpg/png|\n|Reference image of the clothing |1024\u00d7768 recommended, 512\u00d7384 minimum, max side 4096 px.

- If Using a Real-Person Clothing Photo as Reference
   - Must feature only one person.
   - The visible clothing area must fully cover the intended try-on area.
      - Example: For full-body try-on, a half-body clothing image is not acceptable.
      - Example: For lower-body try-on, partial pants are not acceptable.
   - The clothing must not be heavily obstructed (e.g. covered by long hair or arms).
   - The face must be fully visible, with no obstructions.
   - The body must be facing forward in a standing position (no sitting or crouching).

- If Using a Product Image as Reference
   - Must be a front-facing product shot of a single garment.
   - Do not use composite images (e.g. top and bottom in one photo).

- Unsupported Clothing Types
   - Garments with minimal coverage, such as bikinis or underwear, are not currently supported.|< 10MB|jpg/png|\n\n### Error Codes\n|Error Code|Description|\n| ---- | ---- |\n|error_invalid_ref|The uploaded clothing image appears empty or only partially visible\n|error_apply_region_mismatch|The source and reference images don\u2019t match \u2014 for example, the source image shows only the upper body, while the reference image is focused on pants\n|invalid_parameter|- Invalid garment category
- Style_id not in inference_style_list
- Invalid keys/acts|\n|error_download_image|- Download image error|\n|exceed_max_filesize|- image size too large (> 10MB)|\n|error_nsfw_content_detected|- Potential NSFW content detected in result image|\n|unknown_internal_error|- Failed to load model
- Invalid scheduler algorithm type
- No engine loaded
- File not in the upload results|\n\n### Environment & Dependency\n| Sample Code Language / Tool | Recommended Runtime Versions |\n|---|---|\n| cURL | cURL 8.x |\n| Node.js (JavaScript) | Node.js 18.x/20.x LTS |\n| JavaScript | Compatible with Chromium v100 |\n| PHP | PHP 8.1+ |\n| Python | Python 3.10+ |\n| Java | JDK 1.8 or 21 LTS |\n" }, { "name": "AI Clothes", "description": "### AI Clothes\nAI Clothes is a virtual fitting room that lets users try on clothes without physically wearing them. Using AI and photo editing technology, these apps overlay outfits onto your image so you can see how different styles and fits look on your body type. It\u2019s perfect for online shopping, style inspiration, or just playing around with fashion ideas. Try on clothes virtually with AI Clothes . Upload any clothing reference to swap outfits with you photo for an instant virtual wardrobe transformation.\n\n## Integration Guide\n### Try-On Predefined Styles\n1. **Upload file using the File API**
\n Using the ***v1.1/file/cloth*** API to upload a target user image.\n - Image Requirements\n - See details in **[File Specs & Errors](#tag/AI-Clothes/File-Specs-and-Errors)**.\n - Upload a full body photo of yourself. The virtual outfit changer works best with high resolution photos that show your clothes clearly. The photo background should not have too many people or distracting objects.\n\n2. **List Predefined Outfit Styles**
\n There are two ways to list outfits for AI Clothes virtual try-on:\n - ***v1.0/task/style-group/cloth*** and ***v1.0/task/style/cloth***: Retrieve style groups first, then fetch styles within the chosen group.\n - ***v1.1/task/style/cloth***: Fetch a predefined style list by category. If you don\u2019t specify a category_id, each category will contain either styles or subcategories. Categories with a single layer only include styles, while multi-layered categories will have subcategories. To explore a subcategory, pass its ID as category_id and call the list again.\n\n3. **Run an AI task to obtain it's task_id**
\n Execute AI task ***v1.0/task/cloth*** with the clothing image file_id as ref_ids and the target user image file_id as src_ids.\n\n4. **Polling to check the status of a task until it succeed or error**
\n This ***task_id*** is used to monitor the task's status through polling GET 'v1.0/task/cloth' to retrieve the current engine status. Until the engine completes the task, the status will remain 'running', and no units will be consumed during this stage.\n\n **Warning:** Please note that, **Polling** to check the status of a task based on it's ***polling_interval*** is mandotary. A task will be timed out if there is no polling request within the ***polling_interval***, even if the task is processed succefully(Your unit(s) will be consumed).\n\n > **Warning:** You will get a ***InvalidTaskId*** error once you check the status of a timed out task. So, once you run an AI task, you need to **polling** to check the status within the ***polling_interval*** until the status become either *success* or *error*.\n\n5. **Get the result of an AI task once success**
\n The task will change to the 'success' status after the engine successfully processes your input file and generates the resulting image. You will get an url of the processed image and a dst_id that allow you to chain another AI task without re-upload the result image.\n\n### For Custom Clothing Virtual Try-On\n1. **Upload file using the File API**
\n Image Requirements\n - See details in **[File Specs & Errors](#tag/AI-Clothes/File-Specs-and-Errors)**.\n\n Using the ***v1.1/file/cloth*** API, please upload the following assets:\n - A reference image of the clothing\n - A full-body photo to serve as the virtual try-on target\n\n2. **Run an AI task to obtain it's task_id**
\n Execute AI task ***v1.0/task/cloth*** with the clothing image file_id as ref_ids and the target user image file_id as src_ids.\n * To ensure the best results, please follow these requirements:\n * Match Clothing Type to Selected Body Area\n - When selecting Upper Body, the garment must be a top.\n - When selecting Lower Body, the garment must be pants or a skirt.\n - For Dresses or Full-Body Outfits, select Full Body \u2014 not upper or lower body individually.\n\n > **Warning:** Note on Try-On Region Conflicts\n If there's a mismatch between the selected try-on region and the uploaded clothing image, the system will default to the region defined by the clothing image.\n Example: If you select \"Full Body\" but upload an upper-body-only garment, only the upper body will be applied.\n\n > **Warning:** You need to ensure that your source image includes the necessary body part for the virtual clothing to be applied; otherwise, an ***error_apply_region_mismatch*** error will be triggered.\n\n > **Warning:** If the chosen clothing style doesn\u2019t match the body area selected for application, the system prioritizes the clothing image to determine where it will be applied. For example, if a user chooses to apply clothing to the whole body but uploads an image of only the upper body, the clothing will be applied only to the upper body.\n\n3. **Polling to check the status of a task until it succeed or error**
\n This ***task_id*** is used to monitor the task's status through polling GET 'v1.0/task/cloth' to retrieve the current engine status. Until the engine completes the task, the status will remain 'running', and no units will be consumed during this stage.\n\n **Warning:** Please note that, **Polling** to check the status of a task based on it's ***polling_interval*** is mandotary. A task will be timed out if there is no polling request within the ***polling_interval***, even if the task is processed succefully(Your unit(s) will be consumed).\n\n > **Warning:** You will get a ***InvalidTaskId*** error once you check the status of a timed out task. So, once you run an AI task, you need to **polling** to check the status within the ***polling_interval*** until the status become either *success* or *error*.\n\n4. **Get the result of an AI task once success**
\n The task will change to the 'success' status after the engine successfully processes your input file and generates the resulting image. You will get an url of the processed image and a dst_id that allow you to chain another AI task without re-upload the result image.\n\nUse cases:\n![](https://plugins-media.makeupar.com/smb/blog/post/2025-05-08/b80f4ae1-c905-4ec0-b491-e42c15e65575.gif)\n\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/strapi/assets/01%20ai%20clothes%20changer.jpg)\n\n![](https://plugins-media.makeupar.com/smb/blog/post/2023-12-01/45f451aa-4b4f-466d-9da7-4538573c92af.jpg)\n\nSuggestions for How to Shoot:\n![Suggestions for How to Shoot](https://bcw-media.s3.ap-northeast-1.amazonaws.com/strapi/assets/AI-Cloth-Guideline.png \"Suggestions for How to Shoot\")\n\n\n## File Specs & Errors\n### Supported Formats & Dimensions\n|Type|Supported Dimensions|Supported File Size|Supported Formats|\n| ---- | ---- | ---- | ---- |\n|Target user image|1024\u00d7768 recommended, 512\u00d7384 minimum, max side 4096 px.

- Single person only.
- The person should occupy at least 80% of the frame for optimal results.
- The image must show the abdomen to face, including shoulders.
- The face must be fully visible, with no obstructions.
- The body must be facing forward in a standing position (no sitting or crouching). |< 10MB|jpg/png|\n|Reference image of the clothing |1024\u00d7768 recommended, 512\u00d7384 minimum, max side 4096 px.

- If Using a Real-Person Clothing Photo as Reference
   - Must feature only one person.
   - The visible clothing area must fully cover the intended try-on area.
      - Example: For full-body try-on, a half-body clothing image is not acceptable.
      - Example: For lower-body try-on, partial pants are not acceptable.
   - The clothing must not be heavily obstructed (e.g. covered by long hair or arms).
   - The face must be fully visible, with no obstructions.
   - The body must be facing forward in a standing position (no sitting or crouching).

- If Using a Product Image as Reference
   - Must be a front-facing product shot of a single garment.
   - Do not use composite images (e.g. top and bottom in one photo).

- Unsupported Clothing Types
   - Garments with minimal coverage, such as bikinis or underwear, are not currently supported.|< 10MB|jpg/png|\n\n### Error Codes\n|Error Code|Description|\n| ---- | ---- |\n|error_invalid_ref|The uploaded clothing image appears empty or only partially visible\n|error_apply_region_mismatch|The source and reference images don\u2019t match \u2014 for example, the source image shows only the upper body, while the reference image is focused on pants\n|invalid_parameter|- Invalid garment category
- Style_id not in inference_style_list
- Invalid keys/acts|\n|error_download_image|- Download image error|\n|exceed_max_filesize|- image size too large (> 10MB)|\n|error_nsfw_content_detected|- Potential NSFW content detected in result image|\n|unknown_internal_error|- Failed to load model
- Invalid scheduler algorithm type
- No engine loaded
- File not in the upload results|\n\n### Environment & Dependency\n| Sample Code Language / Tool | Recommended Runtime Versions |\n|---|---|\n| cURL | cURL 8.x |\n| Node.js (JavaScript) | Node.js 18.x/20.x LTS |\n| JavaScript | Compatible with Chromium v100 |\n| PHP | PHP 8.1+ |\n| Python | Python 3.10+ |\n| Java | JDK 1.8 or 21 LTS |\n" }, { "name": "AI Fabric", "description": "### AI Fabric\nTransform your look with stunning realism! Explore unique fabric styles with photo mode \u2014 whether it's the elegance of silky textures or the vibrance of bold prints, the AI Fabric API brings materials to life! Developers can craft immersive experiences that let users see and feel fabrics like never before. Plus, fresh fabric updates are always on the way!\n\n#### How to Change Cloth Fabric Styles in Photos with AI\n* Upload Your Photo\n\n Upload a full body photo of yourself. The virtual outfit changer works best with high resolution photos that show your clothes clearly. The photo background should not have too many people or distracting objects.\n* There are two ways to list outfits for AI Fabric virtual try-on:\n - v1.0: First, call the style-group to retrieve groups, then call the style to access styles within the group you're interested in.\n - v1.1: Call the predefined style list by category without passing a category_id. Categories will include either styles or subcategories \u2014 if there\u2019s only one layer, categories will only contain styles. If there are multiple layers, they\u2019ll have subcategories. If you want to explore a subcategory, pass its ID in category_id and call again.\n\n\n\n> **Warning:** You need to ensure that your source image includes the necessary body part for the virtual clothing to be applied; otherwise, an ***error_apply_region_not_detected*** error will be triggered.\n\nUse cases:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/strapi/assets/AI%20Fabric.png)\n\n![](https://plugins-media.makeupar.com/smb/blog/post/2024-05-07/b103976d-1b0e-4bed-aab4-9307308b84d7.jpg)\n\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/strapi/assets/03%20ai%20clothes%20changer.jpg)\n\nSuggestions for How to Shoot:\n![Suggestions for How to Shoot](https://bcw-media.s3.ap-northeast-1.amazonaws.com/strapi/assets/AI-Cloth-Guideline.png \"Suggestions for How to Shoot\")\n\n### Supported Formats & Dimensions\n|AI Feature|Supported Dimensions|Supported File Size|Supported Formats|\n| ---- | ---- | ---- | ---- |\n|AI Fabric|long side <= 4096, single person only, The abdomen, face, and shoulders should all be visible. The face must not be obstructed. The body should be upright and facing forward, without any unusual poses like sitting or squatting.|< 10MB|jpg/jpeg|\n\n### Error Codes\n|Error Code|Description|\n| ---- | ---- |\n|error_apply_region_not_detected|The clothing area is either too small or wasn\u2019t detected in the input image" }, { "name": "AI Face Analyzer", "description": "### AI Face Analyzer\nThe AI Face Analyzer examines face structure, identifying features like face, eye, eyebrow, lip, nose, cheekbone shapes, designed to provide personalized recommendations.\n\n## Integration Guide\n### How to Take Photos for AI Face Analysis\n* Take a selfie facing forward\n - Just one clear photo, looking straight into the camera. It is best to let your hair fall naturally, with your entire face visible and nothing covering it. Brush your hair back to reveal your forehead, and make sure you are looking directly ahead to capture a proper front view.\n - Instead, use the JS Camera Kit to take the photo. Follow the automatic face alignment, lighting guidance, and face size detection to ensure the photo meets the required standards for processing.\n\n### How to Detect Skin Concerns by AI\n1. **Resize your source image**
\n Resize your photo to fit the supported dimensions. See details in **[File Specs & Errors](#tag/AI-Face-Analyzer/File-Specs-and-Errors)**\n\n2. **Upload file using the File API**
\n Using the ***v1.1/file/face-attr-analysis*** API to upload a target user image.\n - Image Requirements\n - See details in **[File Specs & Errors](#tag/AI-Face-Analyzer/File-Specs-and-Errors)**.\n - ***Important***: Simply calling the File API does not upload your file. You must **manually upload** the file to the **URL provided in the File API response**. That URL is your upload destination, make sure the file is successfully transferred there before proceeding.
\n Before calling the AI API, ensure your file has been successfully uploaded. Use the File API to retrieve an upload URL, then upload your file to that location. Once the upload is complete, you'll receive a ***file_id*** in the response, this ID is what you'll use to access AI features related to that file.\n \n > **Warning:** Please note that, you will get an 500 Server Error / unknown_internal_error or 404 Not Found error when using AI APIs if you do not upload the file to the URL provided in the File API response.\n\n3. **Run an AI Face Analysis task**
\n Once the upload is complete, you can select multiple face attributes to analyze using your file ID. Please refer to the **[Inputs & Outputs](#tag/AI-Face-Analyzer/Inputs-and-Outputs)**.
\n Subsequently, calling POST 'task/face-attr-analysis' with the \n File ID executes the enhance task and obtains a ***task_id***.\n\n4. **Polling to check the status of a task until it succeed or error**
\nThis ***task_id*** is used to monitor the task's status through polling GET 'task/face-attr-analysis' to retrieve the current engine status. Until the engine completes the task, the status will remain 'running', and no units will be consumed during this stage.\n\n **Warning:** Please note that, **Polling** to check the status of a task based on it's ***polling_interval*** is mandotary. A task will be timed out if there is no polling request within the ***polling_interval***, even if the task is processed succefully(Your unit(s) will be consumed).\n\n > **Warning:** You will get a ***InvalidTaskId*** error once you check the status of a timed out task. So, once you run an AI task, you need to **polling** to check the status within the ***polling_interval*** until the status become either *success* or *error*.\n\n5. **Get the result of an AI task once success**
\nThe task will change to the 'success' status after the engine successfully processes your input file and generates the resulting image. You will get an url of the processed image and a dst_id that allow you to chain another AI task without re-upload the result image.\nYour units will only be consumed in this case. If the engine fails to process the task, the task's status will change to 'error' and no unit will be consumed.
\nWhen deducting units, the system will prioritize those nearing expiration. If the expiration date is the same, it will deduct the units obtained on the earliest date.\n\n### Real-world examples:\n![](https://plugins-media.makeupar.com/smb/blog/post/2025-01-15/10a4b980-f571-4d08-8f5d-e3ed48db77aa.jpg)\n\n## Inputs & Outputs\n### Face Attributes:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/img_Face_Ratio_sec_01_01_enu_79380baa14.jpg)\n\n| Category | Subcategory | Types |\n|--------------|-------------------|-----------------------------------------------------------------------|\n| **FACE** | Face Shape | Round, Oval, Square, Oblong, Heart, Diamond |\n| **EYES** | Eye Shape | Round, Almond, Narrow |\n| | Eye Size | Big, Small, Average |\n| | Eye Angle | Upturned, Downturned, Average |\n| | Eye Distance | Wide-set, Close-set, Average |\n| | Eyelid | Double-lid, Single-lid, Hooded-lid, Deep-set eyelid |\n| **BROWS** | Eyebrow Shape | Hard Angled, Soft Angled, Rounded, Straight |\n| | Thickness | Sparse, Average, Dense |\n| | Eyebrow Distance | Far-Apart, Close, Average |\n| | Thinness | Sparse, Average, Dense |\n| | Shortness | Short, Average |\n| **LIPS** | Lip Shape | Round, Bow-shape, Downturned, Average |\n| **NOSE** | Nose Width | Broad, Narrow, Average |\n| | Nose Length | Long, Short, Average |\n| **CHEEKBONES**| Cheekbones | Flat, High, Low, Round |\n----\n\n### Face Ratios:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/img_Face_Ratio_sec_01_03_2fe8f06b92.jpg)\n#### `face_angle_strictness_level` \n- **Type:** `string` \n- **Enum:** `\"strict\"`, `\"high\"`, `\"medium\"`, `\"low\"`, `\"flexible\"` \n- **Description:** \n Specifies the strictness level for face angle detection, including pitch, yaw, and roll. Higher strictness improves the accuracy of face attribute analysis. \n **Default:** `\"high\"` \n\n- **Options:** \n | Level | Pitch (\u00b0) | Yaw (\u00b0) | Roll (\u00b0) |\n |-----------|-----------|---------|----------|\n | `strict` | \u2264 4 | \u2264 6 | \u2264 4 |\n | `high` | \u2264 10 | \u2264 10 | \u2264 10 |\n | `medium` | \u2264 15 | \u2264 15 | \u2264 15 |\n | `low` | \u2264 20 | \u2264 20 | \u2264 20 |\n | `flexible`| \u2264 30 | \u2264 30 | \u2264 30 |\n\n---\n\n#### `features` \n- **Type:** `array of strings` \n- **Required:** `true` \n- **Items Enum:** \n - `\"horizontalThird\"` \n - `\"verticalFifth\"` \n - `\"faceAspectRatio\"` \n - `\"eyeAspectRatio\"` \n - `\"eyebrowPosition\"` \n - `\"eyebrowArch\"` \n - `\"eyeHeightToEyebrowDistance\"` \n - `\"noseAspectRatio\"` \n - `\"noseWidthToMouthWidth\"` \n - `\"noseToLipToChin\"` \n - `\"upperLipToLowerLip\"` \n\n- **Description:** \n Specifies the facial features to be analyzed. Each item corresponds to a measurable attribute used in facial geometry and proportion analysis.\n\n----\n\n### Suggestions for How to Shoot:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/strapi/assets/AI_Face_Analysis_how_to_shoot_35ca9af08e.png)\n\n> **Warning:** The width of the face needs to be greater than 60% of the width of the image.\n\n## File Specs & Errors\n### Supported Formats & Dimensions\n|AI Feature|Supported Dimensions|Supported File Size|Supported Formats|\n| ---- | ---- | ---- | ---- |\n|AI Face Analyzer|long side <= 4096, single person only. Images with a side longer than 1080px are automatically resized for analysis.|< 10MB|jpg/jpeg|\n\n### Error Codes\n|Error Code|Description|\n| ---- | ---- |\n| error_below_min_image_size | Source image dimensions must be at least 100\u00d7100 pixels. |\n| error_face_position_invalid | Face must be fully visible, forward-facing, and centered in the image. |\n| error_face_position_too_small | Detected face is too small for analysis. |\n| error_face_position_out_of_boundary | Face extends beyond image boundaries. |\n| error_face_not_forward_facing | Face must be directly facing the camera. |\n| error_face_angle_upward | Face is angled too far upward\u2014slightly tilt head down. |\n| error_face_angle_downward | Face is angled too far downward \u2014 slightly tilt head up. |\n| error_face_angle_leftward | Face is turned too far left \u2014 slightly rotate head right. |\n| error_face_angle_rightward | Face is turned too far right \u2014 slightly rotate head left. |\n| error_face_angle_left_tilt | Face is tilted too far left \u2014 gently tilt head right. | \n| error_face_angle_right_tilt | Face is tilted too far right \u2014 gently tilt head left. |\n\n## JS Camera Kit\nWant to perform AI skin analysis in a browser? This camera kit lets you open your browser\u2019s camera, snap a photo, and you are ready to run an AI skin analysis API task. But if you\u2019d rather create your own version, you\u2019re free to do so! It\u2019s just a JavaScript demo for reference and isn\u2019t mandatory for using the AI Skin Analysis API.\n\n### Download the YMK JS Camera Module\nhttps://plugins-media.makeupar.com/v1.0-skincare-camera-kit/sdk.js\n\n### YMK JS Camera Module API Documentation\n### Introduction\nThis document outlines the JavaScript camera module designed to capture high-quality images for integration into an AI Skin Analysis workflow. The API supports both UI Mode (with built-in camera controls and face quality indicators) and Headless Mode (API-driven without visual components), enabling flexible use cases in web applications.\n\n---\n\n### Quick Start Guide\nThe YMK JS Camera Module API provides robust tools for capturing and validating images tailored for AI analysis workflows. Use UI Mode for user-facing applications and Headless Mode for server-side integration or custom implementations. Always prioritize face quality checks before triggering captures to ensure accurate results.\n#### Prerequisites\n- A webpage with a `\n```\n\n#### UI Mode Integration\nUse this mode for applications requiring a camera preview and automatic face quality checks via predefined UI elements.\n##### Steps:\n1. **Initialize** the module (defaults to UI Mode):\n ```javascript\n YMK.init({\n width: 360,\n height: 480,\n language: \"enu\"\n });\n ```\n2. **Registering Event Handlers** See Event Handling\n3. **Open Camera** with face quality monitoring:\n ```javascript\n YMK.openSkincareCamera(); // Shows built-in UI with camera and overlays\n ```\n4. **Capture Photo** automatically when minimum requirements are met, or manually via the UI.\n5. **Close Module**:\n ```javascript\n YMK.close();\n ```\n\n#### Headless Mode Integration\nIdeal for applications needing minimal overhead (e.g., backend integration) or custom UI implementation.\n##### Steps:\n1. **Set Input Source** (optional):\n ```javascript\n YMK.setCanvasInput(\"base64\", \"data:image/png;base64...\", canvasElement);\n ```\n2. **Initialize in Headless Mode**:\n ```javascript\n YMK.init({\n moduleMode: \"headless\",\n width: 640,\n height: 480,\n snapshotType: \"base64\"\n });\n ```\n3. **Registering Event Handlers** See Event Handling\n4. **Open Specific Module**:\n ```javascript\n YMK.openSkincareCamera();\n ```\n5. **Capture A Photo**:(to be used for AI Skin Analysis task)\n ```javascript\n YMK.capture();\n ```\n6. **Close Module**:\n ```javascript\n YMK.close();\n ```\n\n---\n### API Reference\n| Method | Description | Availability |\n|-----------------------------|----------------------------------------------|-------------|\n| `YMK.init(args)` | Initializes the camera module | UI/Headless |\n| `YMK.setCanvasInput(type, source, input)`
Set input for headless mode.
When using base64 or file:
- Supported image formats: PNG, JPEG
- Supported video format: MP4
Recommended input size: Below 1080p for stability\" |* Fields of arguments *
- type: string; alternatives: [\"image\", \"video\"].
- source (required): string; alternatives: [\"base64\", \"file\", \"canvas\", \"mediaStreamTrack\"].
- input (required): base64-string / File / HTMLCanvasElement / MediaStreamTrack |Headless Mode only |\n| `YMK.capture()` | Captures a frame from the live stream | Headless Mode only |\n| `YMK.getResultCanvas()` | Retrieves an HTMLCanvasElement sized to args.width and args.height from YMK.init | Headless Mode only |\n| `YMK.flipCamera()` | Flip the camera if your device supports it | Headless Mode only |\n\n---\n\n#### Initialization (`YMK.init(args)`)\n**Parameters:**\n```javascript\n{\n width: , // Defaults to responsive based on screen size\n height: , // Defaults to window.screen.height * 0.8 for smaller screens\n moduleMode: \"ui\" or \"headless\", // Default is UI Mode (no explicit headless option in v1.x)\n snapshotType: \"base64\" or \"blob\", // Default is \"base64\" for skinAnalysisDetectionCaptured event\n language: [\"chs\", \"cht\", \"deu\", \"enu\", \"esp\", \"fra\", \"jpn\", \"kor\", \"ptb\", \"ita\"] // Defaults to \"enu\"\n}\n```\n\n### Core Methods\n```javascript\n/**\n * Starts or resumes the live stream.\n * Resumes the live stream if it was previously paused. This function works only in live mode.\n * Options:\n * - restartWebcam (boolean) \u2013 Defaults to false. Set to true to force the webcam to restart when resuming the stream.\n */\nYMK.resume(false);\n\n/**\n * Pauses the camera preview (useful for background tasks).\n */\nYMK.pause();\n\n/**\n * Closes the module entirely (stops camera and releases resources).\n */\nYMK.close();\n\n\n/**\n * See whether the live stream or photo made it onto the canvas.\n */\nYMK.isLoaded();\n\n\n/**\n * Captures a frame by pausing the live stream and triggering the skinAnalysisDetectionCaptured event to retrieve the snapshot image.\n * For best results, call YMK.capture only when face quality is sufficient\u2014meaning \"area\", \"frontal\", and \"lighting\" are all reported as \"good\" or \"ok\" via the faceQualityChanged event.\n * Alternatively, you can trigger it right after receiving the skinAnalysisDetectionCompleted event.\n * Note: Capturing with poor image quality may lead to inaccurate analysis.\n */\nYMK.capture();\n\n/**\n * Retrieves the current FPS (frames per second).\n * Returns:\n * A JavaScript object containing the latest module info at the time the API is called.\n * \u00a0\u00a0\u00a0\u00a0\u2022 fps (number) \u2013 The current frame rate. Defaults to 0 if the engine hasn\u2019t loaded yet.\n * \n */\nYMK.getInfo();\n```\n\n---\n\n\n### Event Handling\n```javascript\n// Add listener example:\nconst faceQualityListener = YMK.addEventListener(\"faceQualityChanged\", handleFaceQuality);\n\nfunction handleFaceQuality(quality) {\n console.log(\"Face Quality:\", quality);\n}\n\n// Remove listener example:\nYMK.removeEventListener(faceQualityListener); // *Note: Headless Mode uses custom event handlers*\n```\n\n### Events\n#### Common Events\n| Event Name | Triggered When | Arguments |\n|-------------------------------|----------------------------------------------|--------------------|\n| `opened` | Module UI is fully rendered | None |\n| `loading(progress: number)` | During module initialization | Progress (0-100%) |\n|`loaded`|Triggered when a live stream or photo is loaded onto the canvas.|None|\n|`closed`| YMK module closed |None|\n| `cameraOpened` | Camera hardware successfully starts | None |\n| `cameraClosed` | Camera closed |None|\n| `cameraFailed` | Accessing camera fails due to permission denial or device error | None |\n\n#### Face Quality Monitoring (`faceQualityChanged`)\n**UI Mode Only:**\n```javascript\nYMK.addEventListener(\"faceQualityChanged\", function(quality) {\n // Check minimum criteria for analysis:\n if (quality.hasFace && quality.area === \"good\" && quality.lighting >= \"ok\") {\n console.log(\"Proceed with Analysis\");\n }\n});\n```\n\n**Headless Mode Example:**\n```javascript\nYMK.addEventListener(\"faceQualityChanged\", function(quality) {\n // Handle specific property checks:\n if (!quality.hasFace) alert(\"No face detected! Keep your face inside the circle.\");\n else if (quality.area === \"outofboundary\") {\n console.log(\"Warning:\", quality.areaMessages[0]); // \"Your face is too close...\"\n }\n});\n```\n#### Module-Specific Events\n| Event Name | Description |Availability|\n|-------------------------------|-----------------------------------------------|--|\n| `faceQualityChanged(quality: object)` | Real-time face quality updates | UI/Headless |\n| `skinAnalysisDetectionStarted` | UI Mode only \u2013 Enters face quality detection page | UI Mode only |\n| `skinAnalysisDetectionCaptured` | In UI mode, this is triggered once a face is qualified and captured. In headless mode, it's triggered right after capturing with YMK.capture
Args: [image]
image: the snapshot image in base64 format or binary format (according to args.snapshotType) | UI/Headless |\n| `unsupportedResolution` | Triggered when the YMK module receives an unexpected width or height | UI Mode only |\n\n**faceQualityChanged Arguments: [quality] quality: JS Object**\n- hasFace: true, false (boolean): Determines if a face is detected. Analysis proceeds only when the value is true.\n- area: \"good\", \"notgood\", \"toosmall\", \"outofboundary\" (string): Assesses whether the user's face is positioned at an appropriate distance. Possible values:\n - \"good\" \u2013 Distance is optimal; analysis can proceed.\n - \"notgood\", \"toosmall\", \"outofboundary\" \u2013 Distance requires adjustment.\n- frontal: \"good\", \"notgood\" (string): Indicates whether the user's face is sufficiently forward-facing.\n - \"good\" \u2013 Alignment is correct; analysis can proceed.\n - \"notgood\" \u2013 Face needs to be repositioned.\n- lighting: \"good\", \"ok\", \"notgood\" (string): Evaluates whether lighting conditions are sufficient.\n - \"good\", \"ok\" \u2013 Lighting is acceptable; analysis can proceed.\n - \"notgood\" \u2013 Additional lighting may be required.\n- nakedeye: \"good\", \"notgood\" (string): Confirms if the user is not wearing eyewear. Applicable only during eyewear auto PD detection.\n - \"good\" \u2013 No eyewear detected; PD analysis can proceed.\n - \"notgood\" \u2013 Eyewear removal may be necessary.\n- faceangle \"good\", \"upward\", \"downward\", \"leftward\", \"rightward\", \"lefttilt\", \"righttilt\" (string): Measures whether the face angle is within acceptable limits. Applicable only during face analyzer detection.\n - \"good\" \u2013 Face orientation is correct; analysis can proceed.\n - \"upward\", \"downward\" \u2013 Indicates pitch angle adjustments may be needed.\n - \"leftward\", \"rightward\" \u2013 Reflects yaw angle deviations.\n - \"lefttilt\", \"righttilt\" \u2013 Represents roll angle changes (detected only when facial ratio analysis is enabled).\n\n---\n\n### Configuration Notes\n- **Quality Criteria:** \n - For skin analysis: `{ hasFace: true, area: \"good\", lighting: \"ok\" }`.\n- **Image Quality Warnings:** Always validate face quality before capturing. Use the following minimum thresholds:\n ```javascript\n const minQuality = {\n hasFace: true,\n area: \"good\",\n frontal: \"good\",\n lighting: \"ok\" // or \"good\"\n };\n ```\n- **Progressive Mode**:\n - UI Mode automatically handles quality checks via visual overlays.\n - Headless Mode requires manual validation (e.g., `YMK.capture` should only be called when faceQuality is acceptable).\n\n---\n\n### Troubleshooting\n#### Camera Access Issues\nIf you encounter an error during camera access, check the following:\n1. Ensure HTTPS or localhost for secure contexts (browser security restrictions).\n2. Request camera permissions explicitly if required by your environment.\n3. Handle `cameraFailed` event to debug permission denial errors.\n\n**Example Error Handling:**\n\n```javascript\nYMK.addEventListener(\"cameraFailed\", function() {\n alert(\"Camera access denied. Please allow permissions or use a different browser/device.\");\n});\n```\n\n---\n" }, { "name": "AI Hair Type Detection", "description": "### AI Hair Type Detection\nImagine having an AI hair expert in your pocket. Our tech dives into your hair's texture, thickness, and curl pattern, picking from ten unique curl shapes and sorting them into nine clear types, from Straight to Super Kinky. You get a full hair profile, and brands can use those insights to deliver spot-on product recommendations and tips just for you.\n\n## Integration Guide\n### How to Take Photos for AI Hair Type Detection\n* Take 3 Photos from left, front facing to right.\n - Just snap three quick selfies. One facing straight ahead, one turning about 45 degrees to the left, and one turning 45 degrees to the right. We're trying to catch the full look of your hair from all sides. Make sure your whole face and the upper boundary of your hair are clearly visible in each photo. Your face should take up around 50% to 80% of the image width. Not too small, not too close. That way, it's sharp enough for analysis. When you turn for the side shots, rotate your head left and right like you're saying 'no' (that's called yaw rotation). Keep your head level with no tilting up, down, or sideways. Skip any back or top-down angles because those wont work for us.\n - You can utilize the JS Camera Kit to snap photos. Make sure your hair is not tied up and let it hang in front of your chest. Turn your head to the right and hold still, and turn to the left to get 3 images to be analyzed.\n\n### How to Detect Hair Type by AI\n* Using the ***/s2s/v1.1/file/hair-type-detection*** API, please upload the following assets:\n - Photos from the front, the right side, and the left side.\n\n* Execute AI task ***/s2s/v1.0/task/hair-type-detection***
\nRun the hair-type detection task by sending in three images: one from the front, one from the right side, and one from the left side. Use their file IDs as the source inputs for the AI.\n\n* Polling to check the status of a task until it succeed or error
\nThis ***task_id*** is used to monitor the task's status through polling GET 'task/hair-type-detection' to retrieve the current engine status. Until the engine completes the task, the status will remain 'running', and no units will be consumed during this stage.\n\n## Hair Type Classification\n|Category|Thumbnail|Hair Type Classification|Description|\n| ---- | ---- | ---- | ---- |\n|1|![](https://d3ss46vukfdtpo.cloudfront.net/static/media/img_t1.b19d4657.jpg)|Straight| This hair type is characterized by strands that lack natural curls and typically fall straight from the root to the tip|\n|2A|![](https://d3ss46vukfdtpo.cloudfront.net/static/media/img_t2A.351ef0a6.jpg)|Slight Wavy| This hair type features subtle, delicate waves with a smooth and tousled texture, but lacks volume at the roots|\n|2B|![](https://d3ss46vukfdtpo.cloudfront.net/static/media/img_t2B.daac62f4.jpg)|Medium Wavy| This hair type that showcases natural S-shaped waves that typically begin in the middle of the hair shaft and delicately hug the head, creating a subtle and sophisticated dimension|\n|2C|![](https://d3ss46vukfdtpo.cloudfront.net/static/media/img_t2C.10ef2132.jpg)|Thick Wavy|The waves in this hair type are characterized by a coarse texture and are shaped like the letter \"S\", starting at the root and continuing down the length of the hair. This hair type is prone to frizz|\n|3A|![](https://d3ss46vukfdtpo.cloudfront.net/static/media/img_t3A.073b6767.jpg)|Loose Curls|These curls are big, relaxed, and bouncy, and have a noticeable sheen from roots to ends|\n|3B|![](https://d3ss46vukfdtpo.cloudfront.net/static/media/img_t3B.06bf109b.jpg)|Medium Curls|This hair type consists of coarse, springy ringlets that are prone to frizz|\n|3C|![](https://d3ss46vukfdtpo.cloudfront.net/static/media/img_t3C.9091ea1e.jpg)|Tight Curls|These curls boast a dense and compact corkscrew shape, lending them plenty of volume|\n|4A|![](https://d3ss46vukfdtpo.cloudfront.net/static/media/img_t4A.cf742771.jpg)|Kinky Soft|This hair type is characterized by tightly packed, springy S-shaped coils|\n|4B|![](https://d3ss46vukfdtpo.cloudfront.net/static/media/img_t4B.4a6300fe.jpg)|Coily|Densely packed coils tightly wound into sharp, zigzag angles|\n|4C|![](https://d3ss46vukfdtpo.cloudfront.net/static/media/img_t4C.4ed5a7f8.jpg)|Extremely Coily|This hair type is characterized by tight, fluffy coils that are more susceptible to breakage|\n\n### Result Arguments\n* mapping: result is a string showing the detected hair type category. Here lists all the possible result strings in an array:\n ```json\n [\"1 to 2a\", \"2a to 2b\", \"2b to 2c\", \"2c to 3a\", \"3a to 3b\", \"3b to 3c\", \"3c to 4a\", \"4a to 4b\", \"4b to 4c\"]\n ```\n* term: a one-to-one mapping string between hair type categories and their classifications. Here lists all the possible result strings in an array:\n ```json\n [\"Straight to Slight Wavy\", \"Slight to Medium Wavy\", \"Medium to Thick Wavy\", \"Thick Wavy to Loose Curls\", \"Loose to Medium Curls\", \"Medium to Tight Curls\", \"Tight Curls to Kinky Soft\", \"Kinky Soft to Coily\", \"Coily to Extremely Coily\"]\n ```\n\n### Suggestions for How to Shoot\n![Suggestions for How to Shoot](https://bcw-media.s3.ap-northeast-1.amazonaws.com/strapi/assets/AI%20Hair%20Type%20Detection_how%20to%20shoot.png \"Suggestions for How to Shoot\")\n\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/strapi/assets/AI%20Skin%20Analysis_camera.png)\n\n## File Specs & Errors\n### Supported Formats & Dimensions\n|Type|Supported Dimensions|Supported File Size|Supported Formats|\n| ---- | ---- | ---- | ---- |\n|AI Hair Type Detection|The image must be at least 100 pixels wide and tall, and no more than 4096 pixels in either dimension. If one side of your image is longer than 1080 pixels, it will be resized automatically to fit within that limit for analysis.|< 10MB|jpg/png|\n\n### Error Codes\n|Error Code|Description|\n| ---- | ---- |\n|error_mismatch_image_size|Make sure all your face photos (front, left, and right) are the same size|\n|error_below_min_image_size|If your image is smaller than 100 pixels in width or height, it's too small to use|\n|error_face_position_invalid|Your face needs to be fully visible in the image, without any parts cut off|\n|error_face_position_too_small|The face in your photo is too small to analyze properly|\n|error_face_position_out_of_boundary|Your face is either too large or partially outside the edges of the photo|\n|error_insufficient_lighting|The lighting is too dim, which makes analysis difficult|\n|error_face_angle_invalid|Your face angle isn't quite right. For front-facing shots, keep your head within 10 degrees of straight. For side-facing shots, the angle should be more than 15 degrees|\n" }, { "name": "AI Hair Length Detection", "description": "### AI Hair Length Detection\nAI Hair Length Measurement offers haircare brands and salons a quick solution to analyze and measure hair length, enabling informed decisions for personalized products and services.\nOur AI is meticulously trained on a vast dataset of diverse images to ensure precise and reliable hair length detection. By analyzing thousands of images of various hair types and styles, it precisely identifies and categorizes five distinct hair lengths, from above-the-ear to mid-back, with exceptional accuracy.\n\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/hair_length_S1_01_enu_b03bd393af.jpg)\n\n## Integration Guide\n### How to Take Photos for AI Hair Length Detection\n* Take a selfie facing forward\n - Just one clear shot, looking straight into the camera. Leave your hair down so it falls over your chest, and make sure you're staring directly ahead for that front-on view.\n - Instead, use the JS Camera Kit to take a photo. Just leave your hair down so it falls over your chest. Don't tie it up.\n\n### How to Detect Hair Length by AI\n* Using the ***/s2s/v1.1/file/hair-length-detection*** API, please upload the following assets:\n - Your selfie photo.\n\n* Execute AI task ***/s2s/v1.0/task/hair-length-detection***
\nRun the hair-length detection task by sending one front facing selfie image. Use it's file ID as the source input for the AI.\n\n* Polling to check the status of a task until it succeed or error
\nThis ***task_id*** is used to monitor the task's status through polling GET 'task/hair-length-detection' to retrieve the current engine status. Until the engine completes the task, the status will remain 'running', and no units will be consumed during this stage.\n\n## Hair Length Classification\n|Thumbnail|Hair Length Classification|Description|\n| ---- | ---- | ---- |\n|![](https://d3ss46vukfdtpo.cloudfront.net/static/media/thumb_hair_lenth_above_the_ears.b41525da.png)|Above-Ear Length|Hair that falls just above the ear, offering a sleek and stylish look that frames the face nicely.|\n|![](https://d3ss46vukfdtpo.cloudfront.net/static/media/thumb_hair_lenth_ear_length.0740b805.png)|Ear-Length|Hair that reaches the earlobe, providing a chic and versatile style that's easy to maintain.|\n|![](https://d3ss46vukfdtpo.cloudfront.net/static/media/thumb_hair_lenth_short_hair.d7f24ddb.png)|Short Hair|Hair that is cut above the shoulders, ideal for a fresh, modern look that\u2019s both bold and low-maintenance.|\n|![](https://d3ss46vukfdtpo.cloudfront.net/static/media/thumb_hair_lenth_above_chest.1b624c17.png)|Medium-Length|Hair that falls around the collarbone, offering a balanced style that\u2019s perfect for both updos and loose waves.|\n|![](https://d3ss46vukfdtpo.cloudfront.net/static/media/thumb_hair_lenth_longer_hair.7fbcc9d0.png)|Long Hair|Long hair that exudes elegance, providing a classic appearance with numerous styling options.|\n\n### Result Arguments\n* term: result is a string showing the detected hair length type. Here lists all the possible result strings in an array:\n ```json\n [\"above the ears\", \"ear length\", \"ear length or longer\", \"short hair\", \"short hair or longer\", \"above chest\", \"above chest or longer\", \"long hair\"]\n ```\n\n### Suggestions for How to Shoot\n![Suggestions for How to Shoot](https://bcw-media.s3.ap-northeast-1.amazonaws.com/strapi/assets/AI%20Hair%20Length%20Detection_how%20to%20shoot.png \"Suggestions for How to Shoot\")\n\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/strapi/assets/AI%20Skin%20Analysis_camera.png)\n\n## File Specs & Errors\n### Supported Formats & Dimensions\n|Type|Supported Dimensions|Supported File Size|Supported Formats|\n| ---- | ---- | ---- | ---- |\n|AI Hair Length Detection|The image must be at least 100 pixels wide and tall, and no more than 4096 pixels in either dimension. If one side of your image is longer than 1080 pixels, it will be resized automatically to fit within that limit for analysis.|< 10MB|jpg/png|\n\n### Error Codes\n|Error Code|Description|\n| ---- | ---- |\n|error_below_min_image_size|If your image is smaller than 100 pixels in width or height, it's too small to use|\n|error_face_position_invalid|Your face needs to be fully visible in the image, without any parts cut off|\n|error_face_position_too_small|The face in your photo is too small to analyze properly|\n|error_face_position_out_of_boundary|Your face is either too large or partially outside the edges of the photo|\n|error_insufficient_lighting|The lighting is too dim, which makes analysis difficult|\n|error_face_angle_invalid|Your face angle isn't quite right. For front-facing shots, keep your head within 10 degrees of straight. For side-facing shots, the angle should be more than 15 degrees|\n" }, { "name": "AI Skin Tone Analysis", "description": "### AI Face Skin Tone Analysis\nThe AI Face Skin Tone Analysis detects facial skin tone, eye, eyebrow, lip & hair colors. This inclusive technology ensures to a complete tailored shopping experience for all ethnicities.\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/img_Face_Ratio_sec_01_02_a3ac9fc222.jpg)\n\n\n## Integration Guide\n### How to Take Photos for AI Face Skin Tone Analysis\n* Take a selfie facing forward\n - Just one clear shot, looking straight into the camera. Leave your hair down so it falls over your chest, and make sure you're staring directly ahead for that front-on view.\n - Instead, use the JS Camera Kit to take a photo. Just leave your hair down so it falls over your chest. Don't tie it up.\n\n### How to Detect Skin Concerns by AI\n1. **Resize your source image**
\n Resize your photo to fit the supported dimensions. See details in **[File Specs & Errors](#tag/AI-Skin-Tone-Analysis/File-Specs-and-Errors)**\n\n2. **Upload file using the File API**
\n Using the ***v1.1/file/face-attr-analysis*** API to upload a target user image.\n - Image Requirements\n - See details in **[File Specs & Errors](#tag/AI-Skin-Tone-Analysis/File-Specs-and-Errors)**.\n - ***Important***: Simply calling the File API does not upload your file. You must **manually upload** the file to the **URL provided in the File API response**. That URL is your upload destination, make sure the file is successfully transferred there before proceeding.
\n Before calling the AI API, ensure your file has been successfully uploaded. Use the File API to retrieve an upload URL, then upload your file to that location. Once the upload is complete, you'll receive a ***file_id*** in the response, this ID is what you'll use to access AI features related to that file.\n \n > **Warning:** Please note that, you will get an 500 Server Error / unknown_internal_error or 404 Not Found error when using AI APIs if you do not upload the file to the URL provided in the File API response.\n\n3. **Run an AI Face Skin Tone Analysis task**
\n Once your upload is complete, the AI will use your file ID to examine the color tones of your lips, eyes, eyebrows, skin, and hair. Please refer to the **[Inputs & Outputs](#tag/AI-Skin-Tone-Analysis/Inputs-and-Outputs)**.
\n Subsequently, calling POST 'task/face-attr-analysis' with the \n File ID executes the enhance task and obtains a ***task_id***.\n\n4. **Polling to check the status of a task until it succeed or error**
\nThis ***task_id*** is used to monitor the task's status through polling GET 'task/face-attr-analysis' to retrieve the current engine status. Until the engine completes the task, the status will remain 'running', and no units will be consumed during this stage.\n\n **Warning:** Please note that, **Polling** to check the status of a task based on it's ***polling_interval*** is mandotary. A task will be timed out if there is no polling request within the ***polling_interval***, even if the task is processed succefully(Your unit(s) will be consumed).\n\n > **Warning:** You will get a ***InvalidTaskId*** error once you check the status of a timed out task. So, once you run an AI task, you need to **polling** to check the status within the ***polling_interval*** until the status become either *success* or *error*.\n\n5. **Get the result of an AI task once success**
\nThe task will change to the 'success' status after the engine successfully processes your input file and generates the resulting image. You will get an url of the processed image and a dst_id that allow you to chain another AI task without re-upload the result image.\nYour units will only be consumed in this case. If the engine fails to process the task, the task's status will change to 'error' and no unit will be consumed.
\nWhen deducting units, the system will prioritize those nearing expiration. If the expiration date is the same, it will deduct the units obtained on the earliest date.\n\n### Real-world examples:\n![](https://plugins-media.makeupar.com/smb/blog/post/2025-01-15/10a4b980-f571-4d08-8f5d-e3ed48db77aa.jpg)\n\n## Inputs & Outputs\n### Inputs\nThe AI will analyze the color tones of your lips, eyes, eyebrows, skin, and hair.\n\n### Outputs\n```json\n{\n \"eye_color\": \"#48515c\",\n \"eye_color_name\": \"Gray\", // string; alternatives: [\"Amber\", \"Brown\", \"Green\", \"Blue\", \"Gray\", \"Other\"]\n \"lip_color\": \"#d37982\",\n \"eyebrow_color\": \"#a17a63\",\n \"skin_color\": \"#b28e73\",\n \"hair_color\": \"#000000\",\n \"hair_color_name\": \"Black\" // string; alternatives: [\"Auburn\", \"Black\", \"Blonde\", \"Brown\", \"Grey/White\", \"Red\"]\n}\n```\n\n### Suggestions for How to Shoot:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/strapi/assets/webp_AI%20Skin%20Analysis_camera_f93315b088.png)\n\n> **Warning:** The width of the face needs to be greater than 60% of the width of the image.\n\n## File Specs & Errors\n### Supported Formats & Dimensions\n|AI Feature|Supported Dimensions|Supported File Size|Supported Formats|\n| ---- | ---- | ---- | ---- |\n|AI Face Skin Tone Analysis|long side <= 4096, single person only. Images with a side longer than 1080px are automatically resized for analysis.|< 10MB|jpg/jpeg|\n\n### Error Codes\n|Error Code|Description|\n| ---- | ---- |\n| error_below_min_image_size | Source image dimensions must be at least 100\u00d7100 pixels. |\n| error_face_position_invalid | Face must be fully visible, forward-facing, and centered in the image. |\n| error_face_position_too_small | Detected face is too small for analysis. |\n| error_face_position_out_of_boundary | Face extends beyond image boundaries. |\n| error_face_not_forward_facing | Face must be directly facing the camera. |\n| error_face_angle_upward | Face is angled too far upward\u2014slightly tilt head down. |\n| error_face_angle_downward | Face is angled too far downward \u2014 slightly tilt head up. |\n| error_face_angle_leftward | Face is turned too far left \u2014 slightly rotate head right. |\n| error_face_angle_rightward | Face is turned too far right \u2014 slightly rotate head left. |\n| error_face_angle_left_tilt | Face is tilted too far left \u2014 gently tilt head right. | \n| error_face_angle_right_tilt | Face is tilted too far right \u2014 gently tilt head left. |\n\n## JS Camera Kit\nWant to perform AI skin analysis in a browser? This camera kit lets you open your browser\u2019s camera, snap a photo, and you are ready to run an AI skin analysis API task. But if you\u2019d rather create your own version, you\u2019re free to do so! It\u2019s just a JavaScript demo for reference and isn\u2019t mandatory for using the AI Skin Analysis API.\n\n### Download the YMK JS Camera Module\nhttps://plugins-media.makeupar.com/v1.0-skincare-camera-kit/sdk.js\n\n### YMK JS Camera Module API Documentation\n### Introduction\nThis document outlines the JavaScript camera module designed to capture high-quality images for integration into an AI Skin Analysis workflow. The API supports both UI Mode (with built-in camera controls and face quality indicators) and Headless Mode (API-driven without visual components), enabling flexible use cases in web applications.\n\n---\n\n### Quick Start Guide\nThe YMK JS Camera Module API provides robust tools for capturing and validating images tailored for AI analysis workflows. Use UI Mode for user-facing applications and Headless Mode for server-side integration or custom implementations. Always prioritize face quality checks before triggering captures to ensure accurate results.\n#### Prerequisites\n- A webpage with a `\n```\n\n#### UI Mode Integration\nUse this mode for applications requiring a camera preview and automatic face quality checks via predefined UI elements.\n##### Steps:\n1. **Initialize** the module (defaults to UI Mode):\n ```javascript\n YMK.init({\n width: 360,\n height: 480,\n language: \"enu\"\n });\n ```\n2. **Registering Event Handlers** See Event Handling\n3. **Open Camera** with face quality monitoring:\n ```javascript\n YMK.openSkincareCamera(); // Shows built-in UI with camera and overlays\n ```\n4. **Capture Photo** automatically when minimum requirements are met, or manually via the UI.\n5. **Close Module**:\n ```javascript\n YMK.close();\n ```\n\n#### Headless Mode Integration\nIdeal for applications needing minimal overhead (e.g., backend integration) or custom UI implementation.\n##### Steps:\n1. **Set Input Source** (optional):\n ```javascript\n YMK.setCanvasInput(\"base64\", \"data:image/png;base64...\", canvasElement);\n ```\n2. **Initialize in Headless Mode**:\n ```javascript\n YMK.init({\n moduleMode: \"headless\",\n width: 640,\n height: 480,\n snapshotType: \"base64\"\n });\n ```\n3. **Registering Event Handlers** See Event Handling\n4. **Open Specific Module**:\n ```javascript\n YMK.openSkincareCamera();\n ```\n5. **Capture A Photo**:(to be used for AI Skin Analysis task)\n ```javascript\n YMK.capture();\n ```\n6. **Close Module**:\n ```javascript\n YMK.close();\n ```\n\n---\n### API Reference\n| Method | Description | Availability |\n|-----------------------------|----------------------------------------------|-------------|\n| `YMK.init(args)` | Initializes the camera module | UI/Headless |\n| `YMK.setCanvasInput(type, source, input)`
Set input for headless mode.
When using base64 or file:
- Supported image formats: PNG, JPEG
- Supported video format: MP4
Recommended input size: Below 1080p for stability\" |* Fields of arguments *
- type: string; alternatives: [\"image\", \"video\"].
- source (required): string; alternatives: [\"base64\", \"file\", \"canvas\", \"mediaStreamTrack\"].
- input (required): base64-string / File / HTMLCanvasElement / MediaStreamTrack |Headless Mode only |\n| `YMK.capture()` | Captures a frame from the live stream | Headless Mode only |\n| `YMK.getResultCanvas()` | Retrieves an HTMLCanvasElement sized to args.width and args.height from YMK.init | Headless Mode only |\n| `YMK.flipCamera()` | Flip the camera if your device supports it | Headless Mode only |\n\n---\n\n#### Initialization (`YMK.init(args)`)\n**Parameters:**\n```javascript\n{\n width: , // Defaults to responsive based on screen size\n height: , // Defaults to window.screen.height * 0.8 for smaller screens\n moduleMode: \"ui\" or \"headless\", // Default is UI Mode (no explicit headless option in v1.x)\n snapshotType: \"base64\" or \"blob\", // Default is \"base64\" for skinAnalysisDetectionCaptured event\n language: [\"chs\", \"cht\", \"deu\", \"enu\", \"esp\", \"fra\", \"jpn\", \"kor\", \"ptb\", \"ita\"] // Defaults to \"enu\"\n}\n```\n\n### Core Methods\n```javascript\n/**\n * Starts or resumes the live stream.\n * Resumes the live stream if it was previously paused. This function works only in live mode.\n * Options:\n * - restartWebcam (boolean) \u2013 Defaults to false. Set to true to force the webcam to restart when resuming the stream.\n */\nYMK.resume(false);\n\n/**\n * Pauses the camera preview (useful for background tasks).\n */\nYMK.pause();\n\n/**\n * Closes the module entirely (stops camera and releases resources).\n */\nYMK.close();\n\n\n/**\n * See whether the live stream or photo made it onto the canvas.\n */\nYMK.isLoaded();\n\n\n/**\n * Captures a frame by pausing the live stream and triggering the skinAnalysisDetectionCaptured event to retrieve the snapshot image.\n * For best results, call YMK.capture only when face quality is sufficient\u2014meaning \"area\", \"frontal\", and \"lighting\" are all reported as \"good\" or \"ok\" via the faceQualityChanged event.\n * Alternatively, you can trigger it right after receiving the skinAnalysisDetectionCompleted event.\n * Note: Capturing with poor image quality may lead to inaccurate analysis.\n */\nYMK.capture();\n\n/**\n * Retrieves the current FPS (frames per second).\n * Returns:\n * A JavaScript object containing the latest module info at the time the API is called.\n * \u00a0\u00a0\u00a0\u00a0\u2022 fps (number) \u2013 The current frame rate. Defaults to 0 if the engine hasn\u2019t loaded yet.\n * \n */\nYMK.getInfo();\n```\n\n---\n\n\n### Event Handling\n```javascript\n// Add listener example:\nconst faceQualityListener = YMK.addEventListener(\"faceQualityChanged\", handleFaceQuality);\n\nfunction handleFaceQuality(quality) {\n console.log(\"Face Quality:\", quality);\n}\n\n// Remove listener example:\nYMK.removeEventListener(faceQualityListener); // *Note: Headless Mode uses custom event handlers*\n```\n\n### Events\n#### Common Events\n| Event Name | Triggered When | Arguments |\n|-------------------------------|----------------------------------------------|--------------------|\n| `opened` | Module UI is fully rendered | None |\n| `loading(progress: number)` | During module initialization | Progress (0-100%) |\n|`loaded`|Triggered when a live stream or photo is loaded onto the canvas.|None|\n|`closed`| YMK module closed |None|\n| `cameraOpened` | Camera hardware successfully starts | None |\n| `cameraClosed` | Camera closed |None|\n| `cameraFailed` | Accessing camera fails due to permission denial or device error | None |\n\n#### Face Quality Monitoring (`faceQualityChanged`)\n**UI Mode Only:**\n```javascript\nYMK.addEventListener(\"faceQualityChanged\", function(quality) {\n // Check minimum criteria for analysis:\n if (quality.hasFace && quality.area === \"good\" && quality.lighting >= \"ok\") {\n console.log(\"Proceed with Analysis\");\n }\n});\n```\n\n**Headless Mode Example:**\n```javascript\nYMK.addEventListener(\"faceQualityChanged\", function(quality) {\n // Handle specific property checks:\n if (!quality.hasFace) alert(\"No face detected! Keep your face inside the circle.\");\n else if (quality.area === \"outofboundary\") {\n console.log(\"Warning:\", quality.areaMessages[0]); // \"Your face is too close...\"\n }\n});\n```\n#### Module-Specific Events\n| Event Name | Description |Availability|\n|-------------------------------|-----------------------------------------------|--|\n| `faceQualityChanged(quality: object)` | Real-time face quality updates | UI/Headless |\n| `skinAnalysisDetectionStarted` | UI Mode only \u2013 Enters face quality detection page | UI Mode only |\n| `skinAnalysisDetectionCaptured` | In UI mode, this is triggered once a face is qualified and captured. In headless mode, it's triggered right after capturing with YMK.capture
Args: [image]
image: the snapshot image in base64 format or binary format (according to args.snapshotType) | UI/Headless |\n| `unsupportedResolution` | Triggered when the YMK module receives an unexpected width or height | UI Mode only |\n\n**faceQualityChanged Arguments: [quality] quality: JS Object**\n- hasFace: true, false (boolean): Determines if a face is detected. Analysis proceeds only when the value is true.\n- area: \"good\", \"notgood\", \"toosmall\", \"outofboundary\" (string): Assesses whether the user's face is positioned at an appropriate distance. Possible values:\n - \"good\" \u2013 Distance is optimal; analysis can proceed.\n - \"notgood\", \"toosmall\", \"outofboundary\" \u2013 Distance requires adjustment.\n- frontal: \"good\", \"notgood\" (string): Indicates whether the user's face is sufficiently forward-facing.\n - \"good\" \u2013 Alignment is correct; analysis can proceed.\n - \"notgood\" \u2013 Face needs to be repositioned.\n- lighting: \"good\", \"ok\", \"notgood\" (string): Evaluates whether lighting conditions are sufficient.\n - \"good\", \"ok\" \u2013 Lighting is acceptable; analysis can proceed.\n - \"notgood\" \u2013 Additional lighting may be required.\n- nakedeye: \"good\", \"notgood\" (string): Confirms if the user is not wearing eyewear. Applicable only during eyewear auto PD detection.\n - \"good\" \u2013 No eyewear detected; PD analysis can proceed.\n - \"notgood\" \u2013 Eyewear removal may be necessary.\n- faceangle \"good\", \"upward\", \"downward\", \"leftward\", \"rightward\", \"lefttilt\", \"righttilt\" (string): Measures whether the face angle is within acceptable limits. Applicable only during face analyzer detection.\n - \"good\" \u2013 Face orientation is correct; analysis can proceed.\n - \"upward\", \"downward\" \u2013 Indicates pitch angle adjustments may be needed.\n - \"leftward\", \"rightward\" \u2013 Reflects yaw angle deviations.\n - \"lefttilt\", \"righttilt\" \u2013 Represents roll angle changes (detected only when facial ratio analysis is enabled).\n\n---\n\n### Configuration Notes\n- **Quality Criteria:** \n - For skin analysis: `{ hasFace: true, area: \"good\", lighting: \"ok\" }`.\n- **Image Quality Warnings:** Always validate face quality before capturing. Use the following minimum thresholds:\n ```javascript\n const minQuality = {\n hasFace: true,\n area: \"good\",\n frontal: \"good\",\n lighting: \"ok\" // or \"good\"\n };\n ```\n- **Progressive Mode**:\n - UI Mode automatically handles quality checks via visual overlays.\n - Headless Mode requires manual validation (e.g., `YMK.capture` should only be called when faceQuality is acceptable).\n\n---\n\n### Troubleshooting\n#### Camera Access Issues\nIf you encounter an error during camera access, check the following:\n1. Ensure HTTPS or localhost for secure contexts (browser security restrictions).\n2. Request camera permissions explicitly if required by your environment.\n3. Handle `cameraFailed` event to debug permission denial errors.\n\n**Example Error Handling:**\n\n```javascript\nYMK.addEventListener(\"cameraFailed\", function() {\n alert(\"Camera access denied. Please allow permissions or use a different browser/device.\");\n});\n```\n\n---\n" }, { "name": "AI Aging Generator", "description": "### AI Aging Generator\nAI aging generator utilizing generative AI model to generate a series of photos from youth to age from a single selfie image. With the help of AI technology, not only can it measure your current age, but it also lets you see yourself in the future or the past.\n\n![AI Aging Generator](https://bcw-media.s3.ap-northeast-1.amazonaws.com/f42f1504_79e3_461c_a3f1_a254623d113b_b068736afb.jpg \"AI Aging Generator\")\n\nThe AI aging generator can generate a series of photos based on one single input selfie image. A sample generated photos are shown below as a quick reference of this feature.\n![AI Aging Generator](https://bcw-media.s3.ap-northeast-1.amazonaws.com/U_2024_04_17_cr_12112b83e2.png \"AI Aging Generator\")\n" } ], "paths": { "/s2s/v1.0/client/auth": { "post": { "summary": "Authenticate and obtain access_token", "tags": [ "Authentication" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "client_id", "id_token" ], "properties": { "client_id": { "type": "string", "example": "", "description": "Your api key" }, "id_token": { "type": "string", "example": "", "description": "Encrypt `client_id=×tamp=` with RSA X.509 format Base64 encoded `client_secret` to obtain `id_token`, where your API Key is the ***client_id*** and the Secret key is the ***client_secret***." } } } } } }, "responses": { "200": { "description": "Successful authentication", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 200, "description": "Response status" }, "result": { "type": "object", "properties": { "access_token": { "type": "string", "example": "AQcCGQ+lAAAAEjQwNTQ4ODQ5MDc1NzYyMTc4MgAAAABBAAABAfpZPqyABAE=.10MGh73dMVN6zjfQMRLPPfvxmNG=", "description": "The access token valid for 2 hours. Pass this as Bearer token to call other APIs" } } } } } } } }, "400": { "$ref": "#/components/responses/InvalidParameters" }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 401, "description": "Response status" }, "error_code": { "type": "string", "enum": [ "InvalidAuthentication" ], "description": "Error code:\n * InvalidAuthentication - Invalid `client_id` or invalid `id_token` or api key expired\n" } } } } } } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request POST \\\n --url https://yce-api-01.perfectcorp.com/s2s/v1.0/client/auth \\\n --header 'content-type: application/json' \\\n --data '{\"client_id\":\"\",\"id_token\":\"\"}'" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'POST',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/client/auth',\n headers: {\n 'content-type': 'application/json'\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({client_id: '', id_token: ''}));\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = JSON.stringify({\n client_id: '',\n id_token: ''\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('POST', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/client/auth');\nxhr.setRequestHeader('content-type', 'application/json');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/client/auth\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => json_encode([\n 'client_id' => '',\n 'id_token' => ''\n ]),\n CURLOPT_HTTPHEADER => [\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\npayload = \"{\\\"client_id\\\":\\\"\\\",\\\"id_token\\\":\\\"\\\"}\"\n\nheaders = { 'content-type': \"application/json\" }\n\nconn.request(\"POST\", \"/s2s/v1.0/client/auth\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/client/auth\"))\n .header(\"content-type\", \"application/json\")\n .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"client_id\\\":\\\"\\\",\\\"id_token\\\":\\\"\\\"}\"))\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.0/client/credit": { "get": { "summary": "Get unit info", "tags": [ "Unit system" ], "security": [ { "BearerAuthentication": [] } ], "responses": { "200": { "description": "Successful retrieval of unit info", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Response status", "example": 200 }, "results": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of this unit", "example": 13105541279084536 }, "type": { "type": "string", "enum": [ "SubsToken", "PaygToken" ], "description": "Type of this unit" }, "amount": { "type": "integer", "description": "Current unit balance", "example": 10 }, "expiry": { "type": "integer", "description": "Unix timestamp of the expiry of this unit (ms)", "example": 1704789135000 } } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request GET \\\n --url https://yce-api-01.perfectcorp.com/s2s/v1.0/client/credit \\\n --header 'Authorization: Bearer '" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'GET',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/client/credit',\n headers: {\n Authorization: 'Bearer '\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('GET', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/client/credit');\nxhr.setRequestHeader('Authorization', 'Bearer ');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/client/credit\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\nheaders = { 'Authorization': \"Bearer \" }\n\nconn.request(\"GET\", \"/s2s/v1.0/client/credit\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/client/credit\"))\n .header(\"Authorization\", \"Bearer \")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.0/client/credit/history": { "get": { "summary": "View unit history", "tags": [ "Unit system" ], "security": [ { "BearerAuthentication": [] } ], "parameters": [ { "name": "page_size", "in": "query", "schema": { "type": "integer", "example": 20 }, "description": "Number of results to return in a page. Valid value should be between 1 and 30. Default 20." }, { "name": "starting_token", "in": "query", "schema": { "type": "string", "example": 13045969587275114 }, "description": "Token for current page. Start with `null` for the first page, and use `next_token` from the previous response to start next page" } ], "responses": { "200": { "description": "Successful retrieval of the unit usage history", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 200, "description": "Response status" }, "result": { "type": "object", "properties": { "next_token": { "type": "string", "example": 13045969587275114, "description": "Token to query next page." }, "history": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 38173479337460984, "description": "Unique identifier of the history" }, "timestamp": { "type": "integer", "example": 1703146067000, "description": "Unix timestamp of the history (ms)" }, "action": { "type": "string", "example": "photo_enhance", "enum": [ "photo_enhance", "api_photo_enhance", "object_removal", "api_object_removal", "background_removal", "api_background_removal", "colorize", "api_colorize", "text_to_image", "api_text_to_image", "hair_style", "api_hair_style", "blur_background", "change_background", "wig", "trial_gift_text_to_image", "sign_up_gift", "subscription_credits", "subscriber_gift", "permanent_credits", "compensation_from_customer_service", "renew", "expire" ], "description": "Action of this history" }, "target_id": { "type": "string", "example": "7TWFkuE2Z9uR0NOxSmQ1rh4PJ5Zx7YJ5U9SAz51q0QHVwMP+Jb1XbjPsf7ZgUgLY", "description": "Id of the target for this unit. For example, when running AI Photo Enhance task, `target_id` for this history will be `task_id` of the AI Photo Enhance task. When purchasing unit, the `target_id` for this history will be `order_id`" }, "info": { "type": "object", "properties": { "credits": { "type": "array", "example": [ { "id": 24409059381740548, "amount": -2 }, { "id": 27297116883780870, "amount": 0 } ], "description": "Detailed information for each unit", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Id of the unit" }, "amount": { "type": "integer", "description": "Total amount changed from this unit" } } } }, "dst_actions": { "type": "array", "description": "The dst_actions of skin analysis", "items": { "type": "string" }, "example": "[ \"hd_wrinkle\", \"hd_pore\", \"hd_texture\" ]" } } } } } } } } } } } } }, "400": { "$ref": "#/components/responses/InvalidParameters" }, "401": { "$ref": "#/components/responses/InvalidAccessToken" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request GET \\\n --url 'https://yce-api-01.perfectcorp.com/s2s/v1.0/client/credit/history?page_size=20&starting_token=13045969587275114' \\\n --header 'Authorization: Bearer '" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'GET',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/client/credit/history?page_size=20&starting_token=13045969587275114',\n headers: {\n Authorization: 'Bearer '\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('GET', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/client/credit/history?page_size=20&starting_token=13045969587275114');\nxhr.setRequestHeader('Authorization', 'Bearer ');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/client/credit/history?page_size=20&starting_token=13045969587275114\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\nheaders = { 'Authorization': \"Bearer \" }\n\nconn.request(\"GET\", \"/s2s/v1.0/client/credit/history?page_size=20&starting_token=13045969587275114\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/client/credit/history?page_size=20&starting_token=13045969587275114\"))\n .header(\"Authorization\", \"Bearer \")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.0/file/enhance": { "post": { "deprecated": true, "summary": "Create a new file.", "tags": [ "AI Photo Enhance" ], "security": [ { "BearerAuthentication": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/File" } ] } } } }, "responses": { "200": { "description": "Successful retrieval of file upload information", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileResponse" } ] } } } }, "400": { "$ref": "#/components/responses/InvalidParameters" }, "401": { "$ref": "#/components/responses/InvalidAccessToken" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request POST \\\n --url https://yce-api-01.perfectcorp.com/s2s/v1.0/file/enhance \\\n --header 'Authorization: Bearer ' \\\n --header 'content-type: application/json' \\\n --data '{\"files\":[{\"content_type\":\"image/jpg\",\"file_name\":\"my-selfie.jpg\"}]}'" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'POST',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/file/enhance',\n headers: {\n Authorization: 'Bearer ',\n 'content-type': 'application/json'\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({files: [{content_type: 'image/jpg', file_name: 'my-selfie.jpg'}]}));\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = JSON.stringify({\n files: [\n {\n content_type: 'image/jpg',\n file_name: 'my-selfie.jpg'\n }\n ]\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('POST', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/file/enhance');\nxhr.setRequestHeader('Authorization', 'Bearer ');\nxhr.setRequestHeader('content-type', 'application/json');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/file/enhance\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => json_encode([\n 'files' => [\n [\n 'content_type' => 'image/jpg',\n 'file_name' => 'my-selfie.jpg'\n ]\n ]\n ]),\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\npayload = \"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\"}]}\"\n\nheaders = {\n 'Authorization': \"Bearer \",\n 'content-type': \"application/json\"\n}\n\nconn.request(\"POST\", \"/s2s/v1.0/file/enhance\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/file/enhance\"))\n .header(\"Authorization\", \"Bearer \")\n .header(\"content-type\", \"application/json\")\n .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\"}]}\"))\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.1/file/enhance": { "post": { "summary": "Create a new file.", "description": "To upload a new file, you'll first need to use the File API. It will give you a URL \u2013 use that URL to upload your file. Once the upload is finished, you can use the file_id from the same response to start using our AI features.", "tags": [ "AI Photo Enhance" ], "security": [ { "BearerAuthentication": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileV1.1" } ] } } } }, "responses": { "200": { "description": "Successful retrieval of file upload information", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileResponse" } ] } } } }, "400": { "$ref": "#/components/responses/InvalidParameters" }, "401": { "$ref": "#/components/responses/InvalidAccessToken" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request POST \\\n --url https://yce-api-01.perfectcorp.com/s2s/v1.1/file/enhance \\\n --header 'Authorization: Bearer ' \\\n --header 'content-type: application/json' \\\n --data '{\"files\":[{\"content_type\":\"image/jpg\",\"file_name\":\"my-selfie.jpg\",\"file_size\":50000}]}'" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'POST',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.1/file/enhance',\n headers: {\n Authorization: 'Bearer ',\n 'content-type': 'application/json'\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n files: [{content_type: 'image/jpg', file_name: 'my-selfie.jpg', file_size: 50000}]\n}));\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = JSON.stringify({\n files: [\n {\n content_type: 'image/jpg',\n file_name: 'my-selfie.jpg',\n file_size: 50000\n }\n ]\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('POST', 'https://yce-api-01.perfectcorp.com/s2s/v1.1/file/enhance');\nxhr.setRequestHeader('Authorization', 'Bearer ');\nxhr.setRequestHeader('content-type', 'application/json');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.1/file/enhance\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => json_encode([\n 'files' => [\n [\n 'content_type' => 'image/jpg',\n 'file_name' => 'my-selfie.jpg',\n 'file_size' => 50000\n ]\n ]\n ]),\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\npayload = \"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\",\\\"file_size\\\":50000}]}\"\n\nheaders = {\n 'Authorization': \"Bearer \",\n 'content-type': \"application/json\"\n}\n\nconn.request(\"POST\", \"/s2s/v1.1/file/enhance\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.1/file/enhance\"))\n .header(\"Authorization\", \"Bearer \")\n .header(\"content-type\", \"application/json\")\n .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\",\\\"file_size\\\":50000}]}\"))\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.0/task/enhance": { "post": { "summary": "Run an AI Photo Enhance task", "description": "Once you start an AI task, you need to keep polling at given polling_interval to check its status until it shows either success or error because if you don't, the task will time out and when you try to check the status later, you'll get an InvalidTaskId error even if the task did finish successfully and your units will still be consumed.", "tags": [ "AI Photo Enhance" ], "security": [ { "BearerAuthentication": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RunEnhanceTask" } ] } } } }, "responses": { "200": { "description": "Successful execution of AI Photo Enhance task", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Response status", "example": 200 }, "result": { "type": "object", "properties": { "task_id": { "type": "string", "description": "ID of this task. This `task_id` will only valid if client continue polling check status API with interval `polling_interval` defined in check status API response. Otherwise, engine might consider client have leave and will not process the task. No unit will be consumed in this case.", "example": "SX9ALF1Z+KIiNa+GaFRp4bI5gijoc/ckI2teebLq35Bo1Nwc++3iXXdKqnU4/LID" } } } } } } } }, "400": { "description": "Failed execution of task", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RunError" } ] } } } }, "401": { "$ref": "#/components/responses/InvalidAccessToken" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request POST \\\n --url https://yce-api-01.perfectcorp.com/s2s/v1.0/task/enhance \\\n --header 'Authorization: Bearer ' \\\n --header 'content-type: application/json' \\\n --data '{\"request_id\":0,\"payload\":{\"file_sets\":{\"src_ids\":[\"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE=\"]},\"actions\":[{\"id\":0,\"params\":{\"scale\":1}}]}}'" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'POST',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/task/enhance',\n headers: {\n Authorization: 'Bearer ',\n 'content-type': 'application/json'\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n request_id: 0,\n payload: {\n file_sets: {src_ids: ['pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE=']},\n actions: [{id: 0, params: {scale: 1}}]\n }\n}));\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = JSON.stringify({\n request_id: 0,\n payload: {\n file_sets: {\n src_ids: [\n 'pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE='\n ]\n },\n actions: [\n {\n id: 0,\n params: {\n scale: 1\n }\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('POST', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/enhance');\nxhr.setRequestHeader('Authorization', 'Bearer ');\nxhr.setRequestHeader('content-type', 'application/json');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/enhance\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => json_encode([\n 'request_id' => 0,\n 'payload' => [\n 'file_sets' => [\n 'src_ids' => [\n 'pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE='\n ]\n ],\n 'actions' => [\n [\n 'id' => 0,\n 'params' => [\n 'scale' => 1\n ]\n ]\n ]\n ]\n ]),\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\npayload = \"{\\\"request_id\\\":0,\\\"payload\\\":{\\\"file_sets\\\":{\\\"src_ids\\\":[\\\"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE=\\\"]},\\\"actions\\\":[{\\\"id\\\":0,\\\"params\\\":{\\\"scale\\\":1}}]}}\"\n\nheaders = {\n 'Authorization': \"Bearer \",\n 'content-type': \"application/json\"\n}\n\nconn.request(\"POST\", \"/s2s/v1.0/task/enhance\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/enhance\"))\n .header(\"Authorization\", \"Bearer \")\n .header(\"content-type\", \"application/json\")\n .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"request_id\\\":0,\\\"payload\\\":{\\\"file_sets\\\":{\\\"src_ids\\\":[\\\"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE=\\\"]},\\\"actions\\\":[{\\\"id\\\":0,\\\"params\\\":{\\\"scale\\\":1}}]}}\"))\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] }, "get": { "summary": "Check an AI Photo Enhance task status", "tags": [ "AI Photo Enhance" ], "security": [ { "BearerAuthentication": [] } ], "parameters": [ { "name": "task_id", "in": "query", "required": true, "schema": { "type": "string", "example": "SX9ALF1Z+KIiNa+GaFRp4bI5gijoc/ckI2teebLq35Bo1Nwc++3iXXdKqnU4/LID" }, "description": "ID of task to check" } ], "responses": { "200": { "description": "Successful check of AI Photo Enhance task status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskStatusResponse" } } } }, "400": { "$ref": "#/components/responses/InvalidTaskId" }, "401": { "$ref": "#/components/responses/InvalidAccessToken" }, "500": { "$ref": "#/components/responses/TaskTimeout" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request GET \\\n --url 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/enhance?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID' \\\n --header 'Authorization: Bearer '" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'GET',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/task/enhance?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID',\n headers: {\n Authorization: 'Bearer '\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('GET', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/enhance?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID');\nxhr.setRequestHeader('Authorization', 'Bearer ');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/enhance?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\nheaders = { 'Authorization': \"Bearer \" }\n\nconn.request(\"GET\", \"/s2s/v1.0/task/enhance?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/enhance?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID\"))\n .header(\"Authorization\", \"Bearer \")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.0/file/obj-removal": { "post": { "deprecated": true, "summary": "Create a new file.", "tags": [ "AI Object Removal" ], "security": [ { "BearerAuthentication": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/File" } ] } } } }, "responses": { "200": { "description": "Successful retrieval of file upload information", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileResponse" } ] } } } }, "400": { "$ref": "#/components/responses/InvalidParameters" }, "401": { "$ref": "#/components/responses/InvalidAccessToken" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request POST \\\n --url https://yce-api-01.perfectcorp.com/s2s/v1.0/file/obj-removal \\\n --header 'Authorization: Bearer ' \\\n --header 'content-type: application/json' \\\n --data '{\"files\":[{\"content_type\":\"image/jpg\",\"file_name\":\"my-selfie.jpg\"}]}'" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'POST',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/file/obj-removal',\n headers: {\n Authorization: 'Bearer ',\n 'content-type': 'application/json'\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({files: [{content_type: 'image/jpg', file_name: 'my-selfie.jpg'}]}));\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = JSON.stringify({\n files: [\n {\n content_type: 'image/jpg',\n file_name: 'my-selfie.jpg'\n }\n ]\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('POST', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/file/obj-removal');\nxhr.setRequestHeader('Authorization', 'Bearer ');\nxhr.setRequestHeader('content-type', 'application/json');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/file/obj-removal\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => json_encode([\n 'files' => [\n [\n 'content_type' => 'image/jpg',\n 'file_name' => 'my-selfie.jpg'\n ]\n ]\n ]),\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\npayload = \"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\"}]}\"\n\nheaders = {\n 'Authorization': \"Bearer \",\n 'content-type': \"application/json\"\n}\n\nconn.request(\"POST\", \"/s2s/v1.0/file/obj-removal\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/file/obj-removal\"))\n .header(\"Authorization\", \"Bearer \")\n .header(\"content-type\", \"application/json\")\n .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\"}]}\"))\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.1/file/obj-removal": { "post": { "summary": "Create a new file.", "description": "To upload a new file, you'll first need to use the File API. It will give you a URL \u2013 use that URL to upload your file. Once the upload is finished, you can use the file_id from the same response to start using our AI features.", "tags": [ "AI Object Removal" ], "security": [ { "BearerAuthentication": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileV1.1" } ] } } } }, "responses": { "200": { "description": "Successful retrieval of file upload information", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileResponse" } ] } } } }, "400": { "$ref": "#/components/responses/InvalidParameters" }, "401": { "$ref": "#/components/responses/InvalidAccessToken" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request POST \\\n --url https://yce-api-01.perfectcorp.com/s2s/v1.1/file/obj-removal \\\n --header 'Authorization: Bearer ' \\\n --header 'content-type: application/json' \\\n --data '{\"files\":[{\"content_type\":\"image/jpg\",\"file_name\":\"my-selfie.jpg\",\"file_size\":50000}]}'" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'POST',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.1/file/obj-removal',\n headers: {\n Authorization: 'Bearer ',\n 'content-type': 'application/json'\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n files: [{content_type: 'image/jpg', file_name: 'my-selfie.jpg', file_size: 50000}]\n}));\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = JSON.stringify({\n files: [\n {\n content_type: 'image/jpg',\n file_name: 'my-selfie.jpg',\n file_size: 50000\n }\n ]\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('POST', 'https://yce-api-01.perfectcorp.com/s2s/v1.1/file/obj-removal');\nxhr.setRequestHeader('Authorization', 'Bearer ');\nxhr.setRequestHeader('content-type', 'application/json');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.1/file/obj-removal\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => json_encode([\n 'files' => [\n [\n 'content_type' => 'image/jpg',\n 'file_name' => 'my-selfie.jpg',\n 'file_size' => 50000\n ]\n ]\n ]),\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\npayload = \"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\",\\\"file_size\\\":50000}]}\"\n\nheaders = {\n 'Authorization': \"Bearer \",\n 'content-type': \"application/json\"\n}\n\nconn.request(\"POST\", \"/s2s/v1.1/file/obj-removal\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.1/file/obj-removal\"))\n .header(\"Authorization\", \"Bearer \")\n .header(\"content-type\", \"application/json\")\n .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\",\\\"file_size\\\":50000}]}\"))\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.0/task/obj-removal": { "post": { "summary": "Run an AI Object Removal task", "description": "Once you start an AI task, you need to keep polling at given polling_interval to check its status until it shows either success or error because if you don't, the task will time out and when you try to check the status later, you'll get an InvalidTaskId error even if the task did finish successfully and your units will still be consumed.", "tags": [ "AI Object Removal" ], "security": [ { "BearerAuthentication": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BasicRunTask" }, { "type": "object", "properties": { "payload": { "allOf": [ { "$ref": "#/components/schemas/MaskRemovalPayloadWithMaskIds" } ] } } } ] } } } }, "responses": { "200": { "description": "Successful execution of AI Object Removal task", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Response status", "example": 200 }, "result": { "type": "object", "properties": { "task_id": { "type": "string", "description": "ID of this task. This `task_id` will only valid if client continue polling check status API with interval `polling_interval` defined in check status API response. Otherwise, engine might consider client have leave and will not process the task. No unit will be consumed in this case.", "example": "SX9ALF1Z+KIiNa+GaFRp4bI5gijoc/ckI2teebLq35Bo1Nwc++3iXXdKqnU4/LID" } } } } } } } }, "400": { "description": "Failed execution of task", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RunError" } ] } } } }, "401": { "$ref": "#/components/responses/InvalidAccessToken" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request POST \\\n --url https://yce-api-01.perfectcorp.com/s2s/v1.0/task/obj-removal \\\n --header 'Authorization: Bearer ' \\\n --header 'content-type: application/json' \\\n --data '{\"request_id\":0,\"payload\":{\"file_sets\":{\"src_ids\":[\"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE=\"],\"mask_ids\":[\"eA1CCL3kG4w2s0kpbo2pkah59VfxzIjxahJD2wWm7zw=\"]},\"actions\":[{\"id\":0,\"params\":{}}]}}'" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'POST',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/task/obj-removal',\n headers: {\n Authorization: 'Bearer ',\n 'content-type': 'application/json'\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n request_id: 0,\n payload: {\n file_sets: {\n src_ids: ['pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE='],\n mask_ids: ['eA1CCL3kG4w2s0kpbo2pkah59VfxzIjxahJD2wWm7zw=']\n },\n actions: [{id: 0, params: {}}]\n }\n}));\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = JSON.stringify({\n request_id: 0,\n payload: {\n file_sets: {\n src_ids: [\n 'pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE='\n ],\n mask_ids: [\n 'eA1CCL3kG4w2s0kpbo2pkah59VfxzIjxahJD2wWm7zw='\n ]\n },\n actions: [\n {\n id: 0,\n params: {}\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('POST', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/obj-removal');\nxhr.setRequestHeader('Authorization', 'Bearer ');\nxhr.setRequestHeader('content-type', 'application/json');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/obj-removal\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => json_encode([\n 'request_id' => 0,\n 'payload' => [\n 'file_sets' => [\n 'src_ids' => [\n 'pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE='\n ],\n 'mask_ids' => [\n 'eA1CCL3kG4w2s0kpbo2pkah59VfxzIjxahJD2wWm7zw='\n ]\n ],\n 'actions' => [\n [\n 'id' => 0,\n 'params' => [\n \n ]\n ]\n ]\n ]\n ]),\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\npayload = \"{\\\"request_id\\\":0,\\\"payload\\\":{\\\"file_sets\\\":{\\\"src_ids\\\":[\\\"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE=\\\"],\\\"mask_ids\\\":[\\\"eA1CCL3kG4w2s0kpbo2pkah59VfxzIjxahJD2wWm7zw=\\\"]},\\\"actions\\\":[{\\\"id\\\":0,\\\"params\\\":{}}]}}\"\n\nheaders = {\n 'Authorization': \"Bearer \",\n 'content-type': \"application/json\"\n}\n\nconn.request(\"POST\", \"/s2s/v1.0/task/obj-removal\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/obj-removal\"))\n .header(\"Authorization\", \"Bearer \")\n .header(\"content-type\", \"application/json\")\n .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"request_id\\\":0,\\\"payload\\\":{\\\"file_sets\\\":{\\\"src_ids\\\":[\\\"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE=\\\"],\\\"mask_ids\\\":[\\\"eA1CCL3kG4w2s0kpbo2pkah59VfxzIjxahJD2wWm7zw=\\\"]},\\\"actions\\\":[{\\\"id\\\":0,\\\"params\\\":{}}]}}\"))\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] }, "get": { "summary": "Check an AI Object Removal task status", "tags": [ "AI Object Removal" ], "security": [ { "BearerAuthentication": [] } ], "parameters": [ { "name": "task_id", "in": "query", "required": true, "schema": { "type": "string", "example": "SX9ALF1Z+KIiNa+GaFRp4bI5gijoc/ckI2teebLq35Bo1Nwc++3iXXdKqnU4/LID" }, "description": "ID of task to check" } ], "responses": { "200": { "description": "Successful check of AI Object Removal task status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskStatusResponse" } } } }, "400": { "$ref": "#/components/responses/InvalidTaskId" }, "401": { "$ref": "#/components/responses/InvalidAccessToken" }, "500": { "$ref": "#/components/responses/TaskTimeout" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request GET \\\n --url 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/obj-removal?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID' \\\n --header 'Authorization: Bearer '" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'GET',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/task/obj-removal?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID',\n headers: {\n Authorization: 'Bearer '\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('GET', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/obj-removal?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID');\nxhr.setRequestHeader('Authorization', 'Bearer ');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/obj-removal?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\nheaders = { 'Authorization': \"Bearer \" }\n\nconn.request(\"GET\", \"/s2s/v1.0/task/obj-removal?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/obj-removal?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID\"))\n .header(\"Authorization\", \"Bearer \")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.1/file/generative-fill": { "post": { "summary": "Create a new file.", "description": "To upload a new file, you'll first need to use the File API. It will give you a URL \u2013 use that URL to upload your file. Once the upload is finished, you can use the file_id from the same response to start using our AI features.", "tags": [ "AI Object Removal Pro" ], "security": [ { "BearerAuthentication": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileV1.1" } ] } } } }, "responses": { "200": { "description": "Successful retrieval of file upload information", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileResponse" } ] } } } }, "400": { "$ref": "#/components/responses/InvalidParameters" }, "401": { "$ref": "#/components/responses/InvalidAccessToken" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request POST \\\n --url https://yce-api-01.perfectcorp.com/s2s/v1.1/file/generative-fill \\\n --header 'Authorization: Bearer ' \\\n --header 'content-type: application/json' \\\n --data '{\"files\":[{\"content_type\":\"image/jpg\",\"file_name\":\"my-selfie.jpg\",\"file_size\":50000}]}'" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'POST',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.1/file/generative-fill',\n headers: {\n Authorization: 'Bearer ',\n 'content-type': 'application/json'\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n files: [{content_type: 'image/jpg', file_name: 'my-selfie.jpg', file_size: 50000}]\n}));\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = JSON.stringify({\n files: [\n {\n content_type: 'image/jpg',\n file_name: 'my-selfie.jpg',\n file_size: 50000\n }\n ]\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('POST', 'https://yce-api-01.perfectcorp.com/s2s/v1.1/file/generative-fill');\nxhr.setRequestHeader('Authorization', 'Bearer ');\nxhr.setRequestHeader('content-type', 'application/json');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.1/file/generative-fill\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => json_encode([\n 'files' => [\n [\n 'content_type' => 'image/jpg',\n 'file_name' => 'my-selfie.jpg',\n 'file_size' => 50000\n ]\n ]\n ]),\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\npayload = \"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\",\\\"file_size\\\":50000}]}\"\n\nheaders = {\n 'Authorization': \"Bearer \",\n 'content-type': \"application/json\"\n}\n\nconn.request(\"POST\", \"/s2s/v1.1/file/generative-fill\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.1/file/generative-fill\"))\n .header(\"Authorization\", \"Bearer \")\n .header(\"content-type\", \"application/json\")\n .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\",\\\"file_size\\\":50000}]}\"))\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.0/task/generative-fill": { "post": { "summary": "Run an AI Object Removal Pro task", "description": "Once you start an AI task, you need to keep polling at given polling_interval to check its status until it shows either success or error because if you don't, the task will time out and when you try to check the status later, you'll get an InvalidTaskId error even if the task did finish successfully and your units will still be consumed.", "tags": [ "AI Object Removal Pro" ], "security": [ { "BearerAuthentication": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BasicRunTask" }, { "type": "object", "properties": { "payload": { "allOf": [ { "$ref": "#/components/schemas/MaskRemovalPayloadWithMskIds" } ] } } } ] } } } }, "responses": { "200": { "description": "Successful execution of AI Object Removal Pro task", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Response status", "example": 200 }, "result": { "type": "object", "properties": { "task_id": { "type": "string", "description": "ID of this task. This `task_id` will only valid if client continue polling check status API with interval `polling_interval` defined in check status API response. Otherwise, engine might consider client have leave and will not process the task. No unit will be consumed in this case.", "example": "SX9ALF1Z+KIiNa+GaFRp4bI5gijoc/ckI2teebLq35Bo1Nwc++3iXXdKqnU4/LID" } } } } } } } }, "400": { "description": "Failed execution of task", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RunError" } ] } } } }, "401": { "$ref": "#/components/responses/InvalidAccessToken" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request POST \\\n --url https://yce-api-01.perfectcorp.com/s2s/v1.0/task/generative-fill \\\n --header 'Authorization: Bearer ' \\\n --header 'content-type: application/json' \\\n --data '{\"request_id\":0,\"payload\":{\"file_sets\":{\"src_ids\":[\"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE=\"],\"msk_ids\":[\"eA1CCL3kG4w2s0kpbo2pkah59VfxzIjxahJD2wWm7zw=\"]},\"actions\":[{\"id\":0,\"params\":{}}]}}'" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'POST',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/task/generative-fill',\n headers: {\n Authorization: 'Bearer ',\n 'content-type': 'application/json'\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n request_id: 0,\n payload: {\n file_sets: {\n src_ids: ['pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE='],\n msk_ids: ['eA1CCL3kG4w2s0kpbo2pkah59VfxzIjxahJD2wWm7zw=']\n },\n actions: [{id: 0, params: {}}]\n }\n}));\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = JSON.stringify({\n request_id: 0,\n payload: {\n file_sets: {\n src_ids: [\n 'pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE='\n ],\n msk_ids: [\n 'eA1CCL3kG4w2s0kpbo2pkah59VfxzIjxahJD2wWm7zw='\n ]\n },\n actions: [\n {\n id: 0,\n params: {}\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('POST', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/generative-fill');\nxhr.setRequestHeader('Authorization', 'Bearer ');\nxhr.setRequestHeader('content-type', 'application/json');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/generative-fill\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => json_encode([\n 'request_id' => 0,\n 'payload' => [\n 'file_sets' => [\n 'src_ids' => [\n 'pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE='\n ],\n 'msk_ids' => [\n 'eA1CCL3kG4w2s0kpbo2pkah59VfxzIjxahJD2wWm7zw='\n ]\n ],\n 'actions' => [\n [\n 'id' => 0,\n 'params' => [\n \n ]\n ]\n ]\n ]\n ]),\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\npayload = \"{\\\"request_id\\\":0,\\\"payload\\\":{\\\"file_sets\\\":{\\\"src_ids\\\":[\\\"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE=\\\"],\\\"msk_ids\\\":[\\\"eA1CCL3kG4w2s0kpbo2pkah59VfxzIjxahJD2wWm7zw=\\\"]},\\\"actions\\\":[{\\\"id\\\":0,\\\"params\\\":{}}]}}\"\n\nheaders = {\n 'Authorization': \"Bearer \",\n 'content-type': \"application/json\"\n}\n\nconn.request(\"POST\", \"/s2s/v1.0/task/generative-fill\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/generative-fill\"))\n .header(\"Authorization\", \"Bearer \")\n .header(\"content-type\", \"application/json\")\n .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"request_id\\\":0,\\\"payload\\\":{\\\"file_sets\\\":{\\\"src_ids\\\":[\\\"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE=\\\"],\\\"msk_ids\\\":[\\\"eA1CCL3kG4w2s0kpbo2pkah59VfxzIjxahJD2wWm7zw=\\\"]},\\\"actions\\\":[{\\\"id\\\":0,\\\"params\\\":{}}]}}\"))\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] }, "get": { "summary": "Check an AI Object Removal Pro task status", "tags": [ "AI Object Removal Pro" ], "security": [ { "BearerAuthentication": [] } ], "parameters": [ { "name": "task_id", "in": "query", "required": true, "schema": { "type": "string", "example": "SX9ALF1Z+KIiNa+GaFRp4bI5gijoc/ckI2teebLq35Bo1Nwc++3iXXdKqnU4/LID" }, "description": "ID of task to check" } ], "responses": { "200": { "description": "Successful check of AI Object Removal Pro task status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskStatusResponse" } } } }, "400": { "$ref": "#/components/responses/InvalidTaskId" }, "401": { "$ref": "#/components/responses/InvalidAccessToken" }, "500": { "$ref": "#/components/responses/TaskTimeout" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request GET \\\n --url 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/generative-fill?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID' \\\n --header 'Authorization: Bearer '" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'GET',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/task/generative-fill?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID',\n headers: {\n Authorization: 'Bearer '\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('GET', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/generative-fill?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID');\nxhr.setRequestHeader('Authorization', 'Bearer ');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/generative-fill?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\nheaders = { 'Authorization': \"Bearer \" }\n\nconn.request(\"GET\", \"/s2s/v1.0/task/generative-fill?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/generative-fill?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID\"))\n .header(\"Authorization\", \"Bearer \")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.0/file/sod": { "post": { "deprecated": true, "summary": "Create a new file.", "tags": [ "AI Photo Background Removal" ], "security": [ { "BearerAuthentication": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/File" } ] } } } }, "responses": { "200": { "description": "Successful retrieval of file upload information", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileResponse" } ] } } } }, "400": { "$ref": "#/components/responses/InvalidParameters" }, "401": { "$ref": "#/components/responses/InvalidAccessToken" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request POST \\\n --url https://yce-api-01.perfectcorp.com/s2s/v1.0/file/sod \\\n --header 'Authorization: Bearer ' \\\n --header 'content-type: application/json' \\\n --data '{\"files\":[{\"content_type\":\"image/jpg\",\"file_name\":\"my-selfie.jpg\"}]}'" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'POST',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/file/sod',\n headers: {\n Authorization: 'Bearer ',\n 'content-type': 'application/json'\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({files: [{content_type: 'image/jpg', file_name: 'my-selfie.jpg'}]}));\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = JSON.stringify({\n files: [\n {\n content_type: 'image/jpg',\n file_name: 'my-selfie.jpg'\n }\n ]\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('POST', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/file/sod');\nxhr.setRequestHeader('Authorization', 'Bearer ');\nxhr.setRequestHeader('content-type', 'application/json');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/file/sod\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => json_encode([\n 'files' => [\n [\n 'content_type' => 'image/jpg',\n 'file_name' => 'my-selfie.jpg'\n ]\n ]\n ]),\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\npayload = \"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\"}]}\"\n\nheaders = {\n 'Authorization': \"Bearer \",\n 'content-type': \"application/json\"\n}\n\nconn.request(\"POST\", \"/s2s/v1.0/file/sod\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/file/sod\"))\n .header(\"Authorization\", \"Bearer \")\n .header(\"content-type\", \"application/json\")\n .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\"}]}\"))\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.1/file/sod": { "post": { "summary": "Create a new file.", "description": "To upload a new file, you'll first need to use the File API. It will give you a URL \u2013 use that URL to upload your file. Once the upload is finished, you can use the file_id from the same response to start using our AI features.", "tags": [ "AI Photo Background Removal" ], "security": [ { "BearerAuthentication": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileV1.1" } ] } } } }, "responses": { "200": { "description": "Successful retrieval of file upload information", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileResponse" } ] } } } }, "400": { "$ref": "#/components/responses/InvalidParameters" }, "401": { "$ref": "#/components/responses/InvalidAccessToken" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request POST \\\n --url https://yce-api-01.perfectcorp.com/s2s/v1.1/file/sod \\\n --header 'Authorization: Bearer ' \\\n --header 'content-type: application/json' \\\n --data '{\"files\":[{\"content_type\":\"image/jpg\",\"file_name\":\"my-selfie.jpg\",\"file_size\":50000}]}'" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'POST',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.1/file/sod',\n headers: {\n Authorization: 'Bearer ',\n 'content-type': 'application/json'\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n files: [{content_type: 'image/jpg', file_name: 'my-selfie.jpg', file_size: 50000}]\n}));\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = JSON.stringify({\n files: [\n {\n content_type: 'image/jpg',\n file_name: 'my-selfie.jpg',\n file_size: 50000\n }\n ]\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('POST', 'https://yce-api-01.perfectcorp.com/s2s/v1.1/file/sod');\nxhr.setRequestHeader('Authorization', 'Bearer ');\nxhr.setRequestHeader('content-type', 'application/json');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.1/file/sod\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => json_encode([\n 'files' => [\n [\n 'content_type' => 'image/jpg',\n 'file_name' => 'my-selfie.jpg',\n 'file_size' => 50000\n ]\n ]\n ]),\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\npayload = \"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\",\\\"file_size\\\":50000}]}\"\n\nheaders = {\n 'Authorization': \"Bearer \",\n 'content-type': \"application/json\"\n}\n\nconn.request(\"POST\", \"/s2s/v1.1/file/sod\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.1/file/sod\"))\n .header(\"Authorization\", \"Bearer \")\n .header(\"content-type\", \"application/json\")\n .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\",\\\"file_size\\\":50000}]}\"))\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.0/task/sod": { "post": { "summary": "Run an AI Photo Background Removal task", "description": "Once you start an AI task, you need to keep polling at given polling_interval to check its status until it shows either success or error because if you don't, the task will time out and when you try to check the status later, you'll get an InvalidTaskId error even if the task did finish successfully and your units will still be consumed.", "tags": [ "AI Photo Background Removal" ], "security": [ { "BearerAuthentication": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RunSodTask" } ] } } } }, "responses": { "200": { "description": "Successful execution of AI Photo Background Removal task", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Response status", "example": 200 }, "result": { "type": "object", "properties": { "task_id": { "type": "string", "description": "ID of this task. This `task_id` will only valid if client continue polling check status API with interval `polling_interval` defined in check status API response. Otherwise, engine might consider client have leave and will not process the task. No unit will be consumed in this case.", "example": "SX9ALF1Z+KIiNa+GaFRp4bI5gijoc/ckI2teebLq35Bo1Nwc++3iXXdKqnU4/LID" } } } } } } } }, "400": { "description": "Failed execution of task", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RunError" } ] } } } }, "401": { "$ref": "#/components/responses/InvalidAccessToken" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request POST \\\n --url https://yce-api-01.perfectcorp.com/s2s/v1.0/task/sod \\\n --header 'Authorization: Bearer ' \\\n --header 'content-type: application/json' \\\n --data '{\"request_id\":0,\"payload\":{\"file_sets\":{\"src_ids\":[\"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE=\"]},\"actions\":[{\"id\":0}]}}'" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'POST',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/task/sod',\n headers: {\n Authorization: 'Bearer ',\n 'content-type': 'application/json'\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n request_id: 0,\n payload: {\n file_sets: {src_ids: ['pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE=']},\n actions: [{id: 0}]\n }\n}));\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = JSON.stringify({\n request_id: 0,\n payload: {\n file_sets: {\n src_ids: [\n 'pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE='\n ]\n },\n actions: [\n {\n id: 0\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('POST', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/sod');\nxhr.setRequestHeader('Authorization', 'Bearer ');\nxhr.setRequestHeader('content-type', 'application/json');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/sod\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => json_encode([\n 'request_id' => 0,\n 'payload' => [\n 'file_sets' => [\n 'src_ids' => [\n 'pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE='\n ]\n ],\n 'actions' => [\n [\n 'id' => 0\n ]\n ]\n ]\n ]),\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\npayload = \"{\\\"request_id\\\":0,\\\"payload\\\":{\\\"file_sets\\\":{\\\"src_ids\\\":[\\\"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE=\\\"]},\\\"actions\\\":[{\\\"id\\\":0}]}}\"\n\nheaders = {\n 'Authorization': \"Bearer \",\n 'content-type': \"application/json\"\n}\n\nconn.request(\"POST\", \"/s2s/v1.0/task/sod\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/sod\"))\n .header(\"Authorization\", \"Bearer \")\n .header(\"content-type\", \"application/json\")\n .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"request_id\\\":0,\\\"payload\\\":{\\\"file_sets\\\":{\\\"src_ids\\\":[\\\"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE=\\\"]},\\\"actions\\\":[{\\\"id\\\":0}]}}\"))\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] }, "get": { "summary": "Check an AI Photo Background Removal task status", "tags": [ "AI Photo Background Removal" ], "security": [ { "BearerAuthentication": [] } ], "parameters": [ { "name": "task_id", "in": "query", "required": true, "schema": { "type": "string", "example": "SX9ALF1Z+KIiNa+GaFRp4bI5gijoc/ckI2teebLq35Bo1Nwc++3iXXdKqnU4/LID" }, "description": "ID of task to check" } ], "responses": { "200": { "description": "Successful check of AI Photo Background Removal task status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskStatusResponse" } } } }, "400": { "$ref": "#/components/responses/InvalidTaskId" }, "401": { "$ref": "#/components/responses/InvalidAccessToken" }, "500": { "$ref": "#/components/responses/TaskTimeout" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request GET \\\n --url 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/sod?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID' \\\n --header 'Authorization: Bearer '" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'GET',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/task/sod?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID',\n headers: {\n Authorization: 'Bearer '\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('GET', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/sod?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID');\nxhr.setRequestHeader('Authorization', 'Bearer ');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/sod?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\nheaders = { 'Authorization': \"Bearer \" }\n\nconn.request(\"GET\", \"/s2s/v1.0/task/sod?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/sod?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID\"))\n .header(\"Authorization\", \"Bearer \")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.0/file/colorize": { "post": { "deprecated": true, "summary": "Create a new file.", "tags": [ "AI Photo Colorize" ], "security": [ { "BearerAuthentication": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/File" } ] } } } }, "responses": { "200": { "description": "Successful retrieval of file upload information", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileResponse" } ] } } } }, "400": { "$ref": "#/components/responses/InvalidParameters" }, "401": { "$ref": "#/components/responses/InvalidAccessToken" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request POST \\\n --url https://yce-api-01.perfectcorp.com/s2s/v1.0/file/colorize \\\n --header 'Authorization: Bearer ' \\\n --header 'content-type: application/json' \\\n --data '{\"files\":[{\"content_type\":\"image/jpg\",\"file_name\":\"my-selfie.jpg\"}]}'" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'POST',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/file/colorize',\n headers: {\n Authorization: 'Bearer ',\n 'content-type': 'application/json'\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({files: [{content_type: 'image/jpg', file_name: 'my-selfie.jpg'}]}));\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = JSON.stringify({\n files: [\n {\n content_type: 'image/jpg',\n file_name: 'my-selfie.jpg'\n }\n ]\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('POST', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/file/colorize');\nxhr.setRequestHeader('Authorization', 'Bearer ');\nxhr.setRequestHeader('content-type', 'application/json');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/file/colorize\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => json_encode([\n 'files' => [\n [\n 'content_type' => 'image/jpg',\n 'file_name' => 'my-selfie.jpg'\n ]\n ]\n ]),\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\npayload = \"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\"}]}\"\n\nheaders = {\n 'Authorization': \"Bearer \",\n 'content-type': \"application/json\"\n}\n\nconn.request(\"POST\", \"/s2s/v1.0/file/colorize\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/file/colorize\"))\n .header(\"Authorization\", \"Bearer \")\n .header(\"content-type\", \"application/json\")\n .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\"}]}\"))\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.1/file/colorize": { "post": { "summary": "Create a new file.", "description": "To upload a new file, you'll first need to use the File API. It will give you a URL \u2013 use that URL to upload your file. Once the upload is finished, you can use the file_id from the same response to start using our AI features.", "tags": [ "AI Photo Colorize" ], "security": [ { "BearerAuthentication": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileV1.1" } ] } } } }, "responses": { "200": { "description": "Successful retrieval of file upload information", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileResponse" } ] } } } }, "400": { "$ref": "#/components/responses/InvalidParameters" }, "401": { "$ref": "#/components/responses/InvalidAccessToken" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request POST \\\n --url https://yce-api-01.perfectcorp.com/s2s/v1.1/file/colorize \\\n --header 'Authorization: Bearer ' \\\n --header 'content-type: application/json' \\\n --data '{\"files\":[{\"content_type\":\"image/jpg\",\"file_name\":\"my-selfie.jpg\",\"file_size\":50000}]}'" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'POST',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.1/file/colorize',\n headers: {\n Authorization: 'Bearer ',\n 'content-type': 'application/json'\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n files: [{content_type: 'image/jpg', file_name: 'my-selfie.jpg', file_size: 50000}]\n}));\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = JSON.stringify({\n files: [\n {\n content_type: 'image/jpg',\n file_name: 'my-selfie.jpg',\n file_size: 50000\n }\n ]\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('POST', 'https://yce-api-01.perfectcorp.com/s2s/v1.1/file/colorize');\nxhr.setRequestHeader('Authorization', 'Bearer ');\nxhr.setRequestHeader('content-type', 'application/json');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.1/file/colorize\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => json_encode([\n 'files' => [\n [\n 'content_type' => 'image/jpg',\n 'file_name' => 'my-selfie.jpg',\n 'file_size' => 50000\n ]\n ]\n ]),\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\npayload = \"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\",\\\"file_size\\\":50000}]}\"\n\nheaders = {\n 'Authorization': \"Bearer \",\n 'content-type': \"application/json\"\n}\n\nconn.request(\"POST\", \"/s2s/v1.1/file/colorize\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.1/file/colorize\"))\n .header(\"Authorization\", \"Bearer \")\n .header(\"content-type\", \"application/json\")\n .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\",\\\"file_size\\\":50000}]}\"))\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.0/task/colorize": { "post": { "summary": "Run an AI Photo Colorize task", "description": "Once you start an AI task, you need to keep polling at given polling_interval to check its status until it shows either success or error because if you don't, the task will time out and when you try to check the status later, you'll get an InvalidTaskId error even if the task did finish successfully and your units will still be consumed.", "tags": [ "AI Photo Colorize" ], "security": [ { "BearerAuthentication": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RunColorizeTask" } ] } } } }, "responses": { "200": { "description": "Successful execution of AI Photo Colorize task", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Response status", "example": 200 }, "result": { "type": "object", "properties": { "task_id": { "type": "string", "description": "ID of this task. This `task_id` will only valid if client continue polling check status API with interval `polling_interval` defined in check status API response. Otherwise, engine might consider client have leave and will not process the task. No unit will be consumed in this case.", "example": "SX9ALF1Z+KIiNa+GaFRp4bI5gijoc/ckI2teebLq35Bo1Nwc++3iXXdKqnU4/LID" } } } } } } } }, "400": { "description": "Failed execution of task", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RunError" } ] } } } }, "401": { "$ref": "#/components/responses/InvalidAccessToken" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request POST \\\n --url https://yce-api-01.perfectcorp.com/s2s/v1.0/task/colorize \\\n --header 'Authorization: Bearer ' \\\n --header 'content-type: application/json' \\\n --data '{\"request_id\":0,\"payload\":{\"file_sets\":{\"src_ids\":[\"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE=\"]},\"actions\":[{\"id\":0}]}}'" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'POST',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/task/colorize',\n headers: {\n Authorization: 'Bearer ',\n 'content-type': 'application/json'\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n request_id: 0,\n payload: {\n file_sets: {src_ids: ['pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE=']},\n actions: [{id: 0}]\n }\n}));\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = JSON.stringify({\n request_id: 0,\n payload: {\n file_sets: {\n src_ids: [\n 'pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE='\n ]\n },\n actions: [\n {\n id: 0\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('POST', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/colorize');\nxhr.setRequestHeader('Authorization', 'Bearer ');\nxhr.setRequestHeader('content-type', 'application/json');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/colorize\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => json_encode([\n 'request_id' => 0,\n 'payload' => [\n 'file_sets' => [\n 'src_ids' => [\n 'pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE='\n ]\n ],\n 'actions' => [\n [\n 'id' => 0\n ]\n ]\n ]\n ]),\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\npayload = \"{\\\"request_id\\\":0,\\\"payload\\\":{\\\"file_sets\\\":{\\\"src_ids\\\":[\\\"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE=\\\"]},\\\"actions\\\":[{\\\"id\\\":0}]}}\"\n\nheaders = {\n 'Authorization': \"Bearer \",\n 'content-type': \"application/json\"\n}\n\nconn.request(\"POST\", \"/s2s/v1.0/task/colorize\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/colorize\"))\n .header(\"Authorization\", \"Bearer \")\n .header(\"content-type\", \"application/json\")\n .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"request_id\\\":0,\\\"payload\\\":{\\\"file_sets\\\":{\\\"src_ids\\\":[\\\"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE=\\\"]},\\\"actions\\\":[{\\\"id\\\":0}]}}\"))\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] }, "get": { "summary": "Check a AI Photo Colorize task status", "tags": [ "AI Photo Colorize" ], "security": [ { "BearerAuthentication": [] } ], "parameters": [ { "name": "task_id", "in": "query", "required": true, "schema": { "type": "string", "example": "SX9ALF1Z+KIiNa+GaFRp4bI5gijoc/ckI2teebLq35Bo1Nwc++3iXXdKqnU4/LID" }, "description": "ID of task to check" } ], "responses": { "200": { "description": "Successful check of AI Photo Colorize task status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskStatusResponse" }, "example": { "status": 200, "result": { "polling_interval": 1000, "status": "success", "error": null, "results": [ { "id": 0, "data": [ { "dst_id": "Iq4cbOV90rXJHSTfBGBTTYXBF9p1B0xCmy8nIrjTa10=", "url": "https://s3-us-west-2.amazonaws.com/yce-us/gst_tsk/a29e54f4-03a8-4ff1-9226-d6c83ae86053/34516942129/cf4d1764-4517-44af-aed8-fc78fc186072.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240101T120225Z&X-Amz-SignedHeaders=host&X-Amz-Expires=7200&X-Amz-Credential=AKIARB77EV5YXEKPIQMM%2F20240101%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=f199a5da82b0b171d873098ab91473f57a872e3b6cfa58ff6ca24e48617fabc0" }, { "dst_id": "xPz+tgDVoHk6cLD4Zrw3ZVn6Ix5MTtJ2uENG5351YmVk", "url": "https://s3-us-west-2.amazonaws.com/yce-us/gst_tsk/a29e54f4-03a8-4ff1-9226-d6c83ae86053/34516942129/21677233-2d49-4a13-bfb4-3f408d137ab9.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20250210T044313Z&X-Amz-SignedHeaders=host&X-Amz-Expires=7200&X-Amz-Credential=AKIARB77EV5YXEKPIQMM%2F20250210%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=7cbeddc007d8dd2c2befa13393f5f041ee6a04710ce589abba48ff03f3bc0dfa" }, { "dst_id": "YFwKeBsOdxunmdzjBd9kBXntmk84lxbn3V6ulQDl5+F4", "url": "https://s3-us-west-2.amazonaws.com/yce-us/gst_tsk/a29e54f4-03a8-4ff1-9226-d6c83ae86053/34516942129/92a41188-cd4b-45c7-bf97-731d4964b550.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20250210T054255Z&X-Amz-SignedHeaders=host&X-Amz-Expires=7200&X-Amz-Credential=AKIARB77EV5YXEKPIQMM%2F20250210%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=0c78286d01dd769ccbf5b351cdbe24cba8c542c5d626d418fad75b85933a5ad6" }, { "dst_id": "PUFjdxuR6rp/Onm1iaVmJvztKdUQ1anQYt/YFk15k+Xg", "url": "https://s3-us-west-2.amazonaws.com/yce-us/gst_tsk/a29e54f4-03a8-4ff1-9226-d6c83ae86053/34516942129/dd4c3d0a-2349-4630-bca8-f25a421c6ac6.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20250211T021240Z&X-Amz-SignedHeaders=host&X-Amz-Expires=7200&X-Amz-Credential=AKIARB77EV5YXEKPIQMM%2F20250211%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=9c56acf769f7e9c1d61a5fdbef798051897a8ad7c3860f7625599396243d55c4" } ] } ] } } } } }, "400": { "$ref": "#/components/responses/InvalidTaskId" }, "401": { "$ref": "#/components/responses/InvalidAccessToken" }, "500": { "$ref": "#/components/responses/TaskTimeout" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request GET \\\n --url 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/colorize?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID' \\\n --header 'Authorization: Bearer '" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'GET',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/task/colorize?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID',\n headers: {\n Authorization: 'Bearer '\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('GET', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/colorize?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID');\nxhr.setRequestHeader('Authorization', 'Bearer ');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/colorize?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\nheaders = { 'Authorization': \"Bearer \" }\n\nconn.request(\"GET\", \"/s2s/v1.0/task/colorize?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/colorize?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID\"))\n .header(\"Authorization\", \"Bearer \")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.0/task/style-group/text-to-image": { "get": { "summary": "List predefined style groups for AI Image Generator task", "tags": [ "AI Image Generator" ], "security": [ { "BearerAuthentication": [] } ], "parameters": [ { "name": "page_size", "in": "query", "schema": { "type": "integer", "example": 20 }, "description": "Number of results to return in this page. Valid value should be between 1 and 20. Default 20." }, { "name": "starting_token", "in": "query", "schema": { "type": "string", "example": 13045969587275114, "description": "Token for current page. Start with `null` for the first page, and use `next_token` from the previous response to start next page" } } ], "responses": { "200": { "description": "Successful retrieval of text-to-image style groups", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Response status", "example": 200 }, "result": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Token to query next page.", "example": 13045969587275114 }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID of style group", "example": 18213963761051864 }, "info": { "type": "object", "properties": { "title": { "type": "string", "description": "Title of this style group", "example": "Cartoon" } } } } } } } } } } } } }, "400": { "$ref": "#/components/responses/InvalidParameters" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request GET \\\n --url 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/style-group/text-to-image?page_size=20&starting_token=13045969587275114' \\\n --header 'Authorization: Bearer '" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'GET',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/task/style-group/text-to-image?page_size=20&starting_token=13045969587275114',\n headers: {\n Authorization: 'Bearer '\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('GET', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/style-group/text-to-image?page_size=20&starting_token=13045969587275114');\nxhr.setRequestHeader('Authorization', 'Bearer ');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/style-group/text-to-image?page_size=20&starting_token=13045969587275114\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\nheaders = { 'Authorization': \"Bearer \" }\n\nconn.request(\"GET\", \"/s2s/v1.0/task/style-group/text-to-image?page_size=20&starting_token=13045969587275114\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/style-group/text-to-image?page_size=20&starting_token=13045969587275114\"))\n .header(\"Authorization\", \"Bearer \")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.0/task/style/text-to-image": { "get": { "summary": "List predefined style for AI Image Generator task", "tags": [ "AI Image Generator" ], "security": [ { "BearerAuthentication": [] } ], "parameters": [ { "name": "page_size", "in": "query", "schema": { "type": "integer", "example": 20 }, "description": "Number of results to return in this page. Valid value should be between 1 and 20. Default 20." }, { "name": "starting_token", "in": "query", "schema": { "type": "string", "example": 13045969587275114 }, "description": "Token for current page. Start with `null` for the first page, and use `next_token` from the previous response to start next page" }, { "name": "style_group_id", "in": "query", "required": true, "schema": { "type": "integer", "example": 18213963761051864 }, "description": "The id of style group" } ], "responses": { "200": { "description": "Successful retrieval of text-to-image parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Response status", "example": 200 }, "result": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Token to query next page.", "example": 13045969587275114 }, "styles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID of style", "example": 22205685004925400 }, "info": { "type": "object", "properties": { "title": { "type": "string", "description": "Title of this style", "example": "1980s" }, "thumb": { "type": "string", "description": "Thumbnail url for this parameter", "example": "https://yce.perfectcorp.com/static/prompt/cartoon/1980s.jpg" } } } } } } } } } } } } }, "400": { "$ref": "#/components/responses/InvalidParameters" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request GET \\\n --url 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/style/text-to-image?page_size=20&starting_token=13045969587275114&style_group_id=18213963761051864' \\\n --header 'Authorization: Bearer '" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'GET',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/task/style/text-to-image?page_size=20&starting_token=13045969587275114&style_group_id=18213963761051864',\n headers: {\n Authorization: 'Bearer '\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('GET', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/style/text-to-image?page_size=20&starting_token=13045969587275114&style_group_id=18213963761051864');\nxhr.setRequestHeader('Authorization', 'Bearer ');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/style/text-to-image?page_size=20&starting_token=13045969587275114&style_group_id=18213963761051864\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\nheaders = { 'Authorization': \"Bearer \" }\n\nconn.request(\"GET\", \"/s2s/v1.0/task/style/text-to-image?page_size=20&starting_token=13045969587275114&style_group_id=18213963761051864\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/style/text-to-image?page_size=20&starting_token=13045969587275114&style_group_id=18213963761051864\"))\n .header(\"Authorization\", \"Bearer \")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.1/task/style/text-to-image": { "get": { "summary": "List predefined style by category", "tags": [ "AI Image Generator" ], "security": [ { "BearerAuthentication": [] } ], "parameters": [ { "$ref": "#/components/parameters/CategoryId" } ], "responses": { "200": { "$ref": "#/components/responses/StyleResponse_V1.1" }, "400": { "$ref": "#/components/responses/InvalidParameters" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request GET \\\n --url 'https://yce-api-01.perfectcorp.com/s2s/v1.1/task/style/text-to-image?category_id=SOME_ARRAY_VALUE' \\\n --header 'Authorization: Bearer '" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'GET',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.1/task/style/text-to-image?category_id=SOME_ARRAY_VALUE',\n headers: {\n Authorization: 'Bearer '\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('GET', 'https://yce-api-01.perfectcorp.com/s2s/v1.1/task/style/text-to-image?category_id=SOME_ARRAY_VALUE');\nxhr.setRequestHeader('Authorization', 'Bearer ');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.1/task/style/text-to-image?category_id=SOME_ARRAY_VALUE\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\nheaders = { 'Authorization': \"Bearer \" }\n\nconn.request(\"GET\", \"/s2s/v1.1/task/style/text-to-image?category_id=SOME_ARRAY_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.1/task/style/text-to-image?category_id=SOME_ARRAY_VALUE\"))\n .header(\"Authorization\", \"Bearer \")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.0/task/text-to-image": { "post": { "summary": "Run an AI Image Generator task", "description": "Once you start an AI task, you need to keep polling at given polling_interval to check its status until it shows either success or error because if you don't, the task will time out and when you try to check the status later, you'll get an InvalidTaskId error even if the task did finish successfully and your units will still be consumed.", "tags": [ "AI Image Generator" ], "security": [ { "BearerAuthentication": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RunTextToImageTask" } ] } } } }, "responses": { "200": { "description": "Successful execution of AI Image Generator task", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Response status", "example": 200 }, "result": { "type": "object", "properties": { "task_id": { "type": "string", "description": "ID of this task. This `task_id` will only valid if client continue polling check status API with interval `polling_interval` defined in check status API response. Otherwise, engine might consider client have leave and will not process the task. No unit will be consumed in this case.", "example": "SX9ALF1Z+KIiNa+GaFRp4bI5gijoc/ckI2teebLq35Bo1Nwc++3iXXdKqnU4/LID" } } } } } } } }, "400": { "description": "Failed execution of task", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RunError" } ] } } } }, "401": { "$ref": "#/components/responses/InvalidAccessToken" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request POST \\\n --url https://yce-api-01.perfectcorp.com/s2s/v1.0/task/text-to-image \\\n --header 'Authorization: Bearer ' \\\n --header 'content-type: application/json' \\\n --data '{\"request_id\":0,\"payload\":{\"actions\":[{\"id\":0,\"params\":{\"prompt\":\"A little cat\",\"negative_prompt\":\"dog\",\"style_group_id\":18213963761051864,\"style_ids\":[22205685004925400],\"steps\":10,\"cfg_scale\":4,\"seed\":[3843718472198472],\"width_ratio\":3,\"height_ratio\":4}}]}}'" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'POST',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/task/text-to-image',\n headers: {\n Authorization: 'Bearer ',\n 'content-type': 'application/json'\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n request_id: 0,\n payload: {\n actions: [\n {\n id: 0,\n params: {\n prompt: 'A little cat',\n negative_prompt: 'dog',\n style_group_id: 18213963761051864,\n style_ids: [22205685004925400],\n steps: 10,\n cfg_scale: 4,\n seed: [3843718472198472],\n width_ratio: 3,\n height_ratio: 4\n }\n }\n ]\n }\n}));\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = JSON.stringify({\n request_id: 0,\n payload: {\n actions: [\n {\n id: 0,\n params: {\n prompt: 'A little cat',\n negative_prompt: 'dog',\n style_group_id: 18213963761051864,\n style_ids: [\n 22205685004925400\n ],\n steps: 10,\n cfg_scale: 4,\n seed: [\n 3843718472198472\n ],\n width_ratio: 3,\n height_ratio: 4\n }\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('POST', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/text-to-image');\nxhr.setRequestHeader('Authorization', 'Bearer ');\nxhr.setRequestHeader('content-type', 'application/json');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/text-to-image\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => json_encode([\n 'request_id' => 0,\n 'payload' => [\n 'actions' => [\n [\n 'id' => 0,\n 'params' => [\n 'prompt' => 'A little cat',\n 'negative_prompt' => 'dog',\n 'style_group_id' => 18213963761051864,\n 'style_ids' => [\n 22205685004925400\n ],\n 'steps' => 10,\n 'cfg_scale' => 4,\n 'seed' => [\n 3843718472198472\n ],\n 'width_ratio' => 3,\n 'height_ratio' => 4\n ]\n ]\n ]\n ]\n ]),\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\npayload = \"{\\\"request_id\\\":0,\\\"payload\\\":{\\\"actions\\\":[{\\\"id\\\":0,\\\"params\\\":{\\\"prompt\\\":\\\"A little cat\\\",\\\"negative_prompt\\\":\\\"dog\\\",\\\"style_group_id\\\":18213963761051864,\\\"style_ids\\\":[22205685004925400],\\\"steps\\\":10,\\\"cfg_scale\\\":4,\\\"seed\\\":[3843718472198472],\\\"width_ratio\\\":3,\\\"height_ratio\\\":4}}]}}\"\n\nheaders = {\n 'Authorization': \"Bearer \",\n 'content-type': \"application/json\"\n}\n\nconn.request(\"POST\", \"/s2s/v1.0/task/text-to-image\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/text-to-image\"))\n .header(\"Authorization\", \"Bearer \")\n .header(\"content-type\", \"application/json\")\n .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"request_id\\\":0,\\\"payload\\\":{\\\"actions\\\":[{\\\"id\\\":0,\\\"params\\\":{\\\"prompt\\\":\\\"A little cat\\\",\\\"negative_prompt\\\":\\\"dog\\\",\\\"style_group_id\\\":18213963761051864,\\\"style_ids\\\":[22205685004925400],\\\"steps\\\":10,\\\"cfg_scale\\\":4,\\\"seed\\\":[3843718472198472],\\\"width_ratio\\\":3,\\\"height_ratio\\\":4}}]}}\"))\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] }, "get": { "summary": "Check a AI Image Generator task status", "tags": [ "AI Image Generator" ], "security": [ { "BearerAuthentication": [] } ], "parameters": [ { "name": "task_id", "in": "query", "required": true, "schema": { "type": "string", "example": "SX9ALF1Z+KIiNa+GaFRp4bI5gijoc/ckI2teebLq35Bo1Nwc++3iXXdKqnU4/LID" }, "description": "ID of task to check" } ], "responses": { "200": { "description": "Successful check of AI Image Generator task status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskStatusResponse" } } } }, "400": { "$ref": "#/components/responses/InvalidTaskId" }, "401": { "$ref": "#/components/responses/InvalidAccessToken" }, "500": { "$ref": "#/components/responses/TaskTimeout" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request GET \\\n --url 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/text-to-image?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID' \\\n --header 'Authorization: Bearer '" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'GET',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/task/text-to-image?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID',\n headers: {\n Authorization: 'Bearer '\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('GET', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/text-to-image?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID');\nxhr.setRequestHeader('Authorization', 'Bearer ');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/text-to-image?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\nheaders = { 'Authorization': \"Bearer \" }\n\nconn.request(\"GET\", \"/s2s/v1.0/task/text-to-image?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/text-to-image?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID\"))\n .header(\"Authorization\", \"Bearer \")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.0/file/hair-style": { "post": { "deprecated": true, "summary": "Create a new file.", "tags": [ "AI Hairstyle Generator V1" ], "security": [ { "BearerAuthentication": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/File" } ] } } } }, "responses": { "200": { "description": "Successful retrieval of file upload information", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileResponse" } ] } } } }, "400": { "$ref": "#/components/responses/InvalidParameters" }, "401": { "$ref": "#/components/responses/InvalidAccessToken" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request POST \\\n --url https://yce-api-01.perfectcorp.com/s2s/v1.0/file/hair-style \\\n --header 'Authorization: Bearer ' \\\n --header 'content-type: application/json' \\\n --data '{\"files\":[{\"content_type\":\"image/jpg\",\"file_name\":\"my-selfie.jpg\"}]}'" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'POST',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/file/hair-style',\n headers: {\n Authorization: 'Bearer ',\n 'content-type': 'application/json'\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({files: [{content_type: 'image/jpg', file_name: 'my-selfie.jpg'}]}));\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = JSON.stringify({\n files: [\n {\n content_type: 'image/jpg',\n file_name: 'my-selfie.jpg'\n }\n ]\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('POST', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/file/hair-style');\nxhr.setRequestHeader('Authorization', 'Bearer ');\nxhr.setRequestHeader('content-type', 'application/json');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/file/hair-style\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => json_encode([\n 'files' => [\n [\n 'content_type' => 'image/jpg',\n 'file_name' => 'my-selfie.jpg'\n ]\n ]\n ]),\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\npayload = \"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\"}]}\"\n\nheaders = {\n 'Authorization': \"Bearer \",\n 'content-type': \"application/json\"\n}\n\nconn.request(\"POST\", \"/s2s/v1.0/file/hair-style\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/file/hair-style\"))\n .header(\"Authorization\", \"Bearer \")\n .header(\"content-type\", \"application/json\")\n .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\"}]}\"))\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.1/file/hair-style": { "post": { "summary": "Create a new file.", "description": "To upload a new file, you'll first need to use the File API. It will give you a URL \u2013 use that URL to upload your file. Once the upload is finished, you can use the file_id from the same response to start using our AI features.", "tags": [ "AI Hairstyle Generator V1" ], "security": [ { "BearerAuthentication": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileV1.1" } ] } } } }, "responses": { "200": { "description": "Successful retrieval of file upload information", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileResponse" } ] } } } }, "400": { "$ref": "#/components/responses/InvalidParameters" }, "401": { "$ref": "#/components/responses/InvalidAccessToken" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request POST \\\n --url https://yce-api-01.perfectcorp.com/s2s/v1.1/file/hair-style \\\n --header 'Authorization: Bearer ' \\\n --header 'content-type: application/json' \\\n --data '{\"files\":[{\"content_type\":\"image/jpg\",\"file_name\":\"my-selfie.jpg\",\"file_size\":50000}]}'" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'POST',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.1/file/hair-style',\n headers: {\n Authorization: 'Bearer ',\n 'content-type': 'application/json'\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n files: [{content_type: 'image/jpg', file_name: 'my-selfie.jpg', file_size: 50000}]\n}));\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = JSON.stringify({\n files: [\n {\n content_type: 'image/jpg',\n file_name: 'my-selfie.jpg',\n file_size: 50000\n }\n ]\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('POST', 'https://yce-api-01.perfectcorp.com/s2s/v1.1/file/hair-style');\nxhr.setRequestHeader('Authorization', 'Bearer ');\nxhr.setRequestHeader('content-type', 'application/json');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.1/file/hair-style\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => json_encode([\n 'files' => [\n [\n 'content_type' => 'image/jpg',\n 'file_name' => 'my-selfie.jpg',\n 'file_size' => 50000\n ]\n ]\n ]),\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\npayload = \"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\",\\\"file_size\\\":50000}]}\"\n\nheaders = {\n 'Authorization': \"Bearer \",\n 'content-type': \"application/json\"\n}\n\nconn.request(\"POST\", \"/s2s/v1.1/file/hair-style\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.1/file/hair-style\"))\n .header(\"Authorization\", \"Bearer \")\n .header(\"content-type\", \"application/json\")\n .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\",\\\"file_size\\\":50000}]}\"))\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.0/task/style-group/hair-style": { "get": { "summary": "List predefined style groups for AI Hairstyle Generator task", "tags": [ "AI Hairstyle Generator V1" ], "security": [ { "BearerAuthentication": [] } ], "parameters": [ { "name": "page_size", "in": "query", "schema": { "type": "integer", "example": 20 }, "description": "Number of results to return in this page. Valid value should be between 1 and 20. Default 20." }, { "name": "starting_token", "in": "query", "schema": { "type": "string", "example": 13045969587275114 }, "description": "Token for current page. Start with `null` for the first page, and use `next_token` from the previous response to start next page" } ], "responses": { "200": { "description": "Successful retrieval of hair-style style groups", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Response status", "example": 200 }, "result": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Token to query next page.", "example": 13045969587275114 }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID of style group", "example": 18213963761051864 }, "info": { "type": "object", "properties": { "title": { "type": "string", "description": "Title of this style group", "example": "Female" } } } } } } } } } } } } }, "400": { "$ref": "#/components/responses/InvalidParameters" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request GET \\\n --url 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/style-group/hair-style?page_size=20&starting_token=13045969587275114' \\\n --header 'Authorization: Bearer '" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'GET',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/task/style-group/hair-style?page_size=20&starting_token=13045969587275114',\n headers: {\n Authorization: 'Bearer '\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('GET', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/style-group/hair-style?page_size=20&starting_token=13045969587275114');\nxhr.setRequestHeader('Authorization', 'Bearer ');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/style-group/hair-style?page_size=20&starting_token=13045969587275114\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\nheaders = { 'Authorization': \"Bearer \" }\n\nconn.request(\"GET\", \"/s2s/v1.0/task/style-group/hair-style?page_size=20&starting_token=13045969587275114\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/style-group/hair-style?page_size=20&starting_token=13045969587275114\"))\n .header(\"Authorization\", \"Bearer \")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.0/task/style/hair-style": { "get": { "summary": "List predefined style for AI Hairstyle Generator task", "tags": [ "AI Hairstyle Generator V1" ], "security": [ { "BearerAuthentication": [] } ], "parameters": [ { "name": "page_size", "in": "query", "schema": { "type": "integer", "example": 20 }, "description": "Number of results to return in this page. Valid value should be between 1 and 20. Default 20." }, { "name": "starting_token", "in": "query", "schema": { "type": "string", "example": 13045969587275114 }, "description": "Token for current page. Start with `null` for the first page, and use `next_token` from the previous response to start next page" }, { "name": "style_group_id", "in": "query", "required": true, "schema": { "type": "integer", "example": 18213963761051864 }, "description": "The id of style group" } ], "responses": { "200": { "description": "Successful retrieval of hair-style parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Response status", "example": 200 }, "result": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Token to query next page.", "example": 13045969587275114 }, "styles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID of style", "example": 22205685004925400 }, "info": { "type": "object", "properties": { "title": { "type": "string", "description": "Title of this style", "example": "Long Wave" }, "thumb": { "type": "string", "description": "Thumbnail url for this parameter", "example": "https://yce.perfectcorp.com/static/prompt/female/long_wave.jpg" } } } } } } } } } } } } }, "400": { "$ref": "#/components/responses/InvalidParameters" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request GET \\\n --url 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/style/hair-style?page_size=20&starting_token=13045969587275114&style_group_id=18213963761051864' \\\n --header 'Authorization: Bearer '" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'GET',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/task/style/hair-style?page_size=20&starting_token=13045969587275114&style_group_id=18213963761051864',\n headers: {\n Authorization: 'Bearer '\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('GET', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/style/hair-style?page_size=20&starting_token=13045969587275114&style_group_id=18213963761051864');\nxhr.setRequestHeader('Authorization', 'Bearer ');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/style/hair-style?page_size=20&starting_token=13045969587275114&style_group_id=18213963761051864\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\nheaders = { 'Authorization': \"Bearer \" }\n\nconn.request(\"GET\", \"/s2s/v1.0/task/style/hair-style?page_size=20&starting_token=13045969587275114&style_group_id=18213963761051864\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/style/hair-style?page_size=20&starting_token=13045969587275114&style_group_id=18213963761051864\"))\n .header(\"Authorization\", \"Bearer \")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.1/task/style/hair-style": { "get": { "summary": "List predefined style by category", "tags": [ "AI Hairstyle Generator V1" ], "security": [ { "BearerAuthentication": [] } ], "parameters": [ { "$ref": "#/components/parameters/CategoryId" } ], "responses": { "200": { "$ref": "#/components/responses/StyleResponse_V1.1" }, "400": { "$ref": "#/components/responses/InvalidParameters" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request GET \\\n --url 'https://yce-api-01.perfectcorp.com/s2s/v1.1/task/style/hair-style?category_id=SOME_ARRAY_VALUE' \\\n --header 'Authorization: Bearer '" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'GET',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.1/task/style/hair-style?category_id=SOME_ARRAY_VALUE',\n headers: {\n Authorization: 'Bearer '\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('GET', 'https://yce-api-01.perfectcorp.com/s2s/v1.1/task/style/hair-style?category_id=SOME_ARRAY_VALUE');\nxhr.setRequestHeader('Authorization', 'Bearer ');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.1/task/style/hair-style?category_id=SOME_ARRAY_VALUE\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\nheaders = { 'Authorization': \"Bearer \" }\n\nconn.request(\"GET\", \"/s2s/v1.1/task/style/hair-style?category_id=SOME_ARRAY_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.1/task/style/hair-style?category_id=SOME_ARRAY_VALUE\"))\n .header(\"Authorization\", \"Bearer \")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.0/task/hair-style": { "post": { "summary": "Run an AI Hairstyle Generator task", "description": "Once you start an AI task, you need to keep polling at given polling_interval to check its status until it shows either success or error because if you don't, the task will time out and when you try to check the status later, you'll get an InvalidTaskId error even if the task did finish successfully and your units will still be consumed.", "tags": [ "AI Hairstyle Generator V1" ], "security": [ { "BearerAuthentication": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RunHairStyleTask" } ] } } } }, "responses": { "200": { "description": "Successful execution of the AI Hairstyle Generator task", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Response status", "example": 200 }, "result": { "type": "object", "properties": { "task_id": { "type": "string", "description": "ID of this task. This `task_id` will only valid if client continue polling check status API with interval `polling_interval` defined in check status API response. Otherwise, engine might consider client have leave and will not process the task. No unit will be consumed in this case.", "example": "SX9ALF1Z+KIiNa+GaFRp4bI5gijoc/ckI2teebLq35Bo1Nwc++3iXXdKqnU4/LID" } } } } } } } }, "400": { "description": "Failed execution of task", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RunError" } ] } } } }, "401": { "$ref": "#/components/responses/InvalidAccessToken" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request POST \\\n --url https://yce-api-01.perfectcorp.com/s2s/v1.0/task/hair-style \\\n --header 'Authorization: Bearer ' \\\n --header 'content-type: application/json' \\\n --data '{\"request_id\":0,\"payload\":{\"file_sets\":{\"src_ids\":[\"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE=\"]},\"actions\":[{\"id\":0,\"params\":{\"style_group_id\":18213963761051864,\"style_ids\":[22205685004925400]}}]}}'" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'POST',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/task/hair-style',\n headers: {\n Authorization: 'Bearer ',\n 'content-type': 'application/json'\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n request_id: 0,\n payload: {\n file_sets: {src_ids: ['pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE=']},\n actions: [\n {\n id: 0,\n params: {style_group_id: 18213963761051864, style_ids: [22205685004925400]}\n }\n ]\n }\n}));\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = JSON.stringify({\n request_id: 0,\n payload: {\n file_sets: {\n src_ids: [\n 'pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE='\n ]\n },\n actions: [\n {\n id: 0,\n params: {\n style_group_id: 18213963761051864,\n style_ids: [\n 22205685004925400\n ]\n }\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('POST', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/hair-style');\nxhr.setRequestHeader('Authorization', 'Bearer ');\nxhr.setRequestHeader('content-type', 'application/json');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/hair-style\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => json_encode([\n 'request_id' => 0,\n 'payload' => [\n 'file_sets' => [\n 'src_ids' => [\n 'pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE='\n ]\n ],\n 'actions' => [\n [\n 'id' => 0,\n 'params' => [\n 'style_group_id' => 18213963761051864,\n 'style_ids' => [\n 22205685004925400\n ]\n ]\n ]\n ]\n ]\n ]),\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\npayload = \"{\\\"request_id\\\":0,\\\"payload\\\":{\\\"file_sets\\\":{\\\"src_ids\\\":[\\\"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE=\\\"]},\\\"actions\\\":[{\\\"id\\\":0,\\\"params\\\":{\\\"style_group_id\\\":18213963761051864,\\\"style_ids\\\":[22205685004925400]}}]}}\"\n\nheaders = {\n 'Authorization': \"Bearer \",\n 'content-type': \"application/json\"\n}\n\nconn.request(\"POST\", \"/s2s/v1.0/task/hair-style\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/hair-style\"))\n .header(\"Authorization\", \"Bearer \")\n .header(\"content-type\", \"application/json\")\n .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"request_id\\\":0,\\\"payload\\\":{\\\"file_sets\\\":{\\\"src_ids\\\":[\\\"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE=\\\"]},\\\"actions\\\":[{\\\"id\\\":0,\\\"params\\\":{\\\"style_group_id\\\":18213963761051864,\\\"style_ids\\\":[22205685004925400]}}]}}\"))\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] }, "get": { "summary": "Check the status of a AI Hairstyle Generator task", "tags": [ "AI Hairstyle Generator V1" ], "security": [ { "BearerAuthentication": [] } ], "parameters": [ { "name": "task_id", "in": "query", "required": true, "schema": { "type": "string", "example": "SX9ALF1Z+KIiNa+GaFRp4bI5gijoc/ckI2teebLq35Bo1Nwc++3iXXdKqnU4/LID" }, "description": "ID of task to check" } ], "responses": { "200": { "description": "Successful check of the AI Hairstyle Generator task status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskStatusResponse" } } } }, "400": { "$ref": "#/components/responses/InvalidTaskId" }, "401": { "$ref": "#/components/responses/InvalidAccessToken" }, "500": { "$ref": "#/components/responses/TaskTimeout" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request GET \\\n --url 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/hair-style?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID' \\\n --header 'Authorization: Bearer '" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'GET',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/task/hair-style?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID',\n headers: {\n Authorization: 'Bearer '\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('GET', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/hair-style?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID');\nxhr.setRequestHeader('Authorization', 'Bearer ');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/hair-style?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\nheaders = { 'Authorization': \"Bearer \" }\n\nconn.request(\"GET\", \"/s2s/v1.0/task/hair-style?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/hair-style?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID\"))\n .header(\"Authorization\", \"Bearer \")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v2.0/file/hair-style": { "post": { "summary": "Create a new file V2.", "description": "To upload a new file, you'll first need to use the File API. It will give you a URL \u2013 use that URL to upload your file. Once the upload is finished, you can use the file_id from the same response to start using our AI features.", "tags": [ "AI Hairstyle Generator" ], "security": [ { "BearerAuthenticationV2": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileV1.1" } ] } } } }, "responses": { "200": { "description": "Successful retrieval of file upload information", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileResponseV2" } ] } } } }, "400": { "$ref": "#/components/responses/InvalidParameters" }, "401": { "$ref": "#/components/responses/InvalidApiKey" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request POST \\\n --url https://yce-api-01.perfectcorp.com/s2s/v2.0/file/hair-style \\\n --header 'Authorization: Bearer ' \\\n --header 'content-type: application/json' \\\n --data '{\"files\":[{\"content_type\":\"image/jpg\",\"file_name\":\"my-selfie.jpg\",\"file_size\":50000}]}'" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'POST',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v2.0/file/hair-style',\n headers: {\n Authorization: 'Bearer ',\n 'content-type': 'application/json'\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n files: [{content_type: 'image/jpg', file_name: 'my-selfie.jpg', file_size: 50000}]\n}));\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = JSON.stringify({\n files: [\n {\n content_type: 'image/jpg',\n file_name: 'my-selfie.jpg',\n file_size: 50000\n }\n ]\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('POST', 'https://yce-api-01.perfectcorp.com/s2s/v2.0/file/hair-style');\nxhr.setRequestHeader('Authorization', 'Bearer ');\nxhr.setRequestHeader('content-type', 'application/json');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v2.0/file/hair-style\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => json_encode([\n 'files' => [\n [\n 'content_type' => 'image/jpg',\n 'file_name' => 'my-selfie.jpg',\n 'file_size' => 50000\n ]\n ]\n ]),\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\npayload = \"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\",\\\"file_size\\\":50000}]}\"\n\nheaders = {\n 'Authorization': \"Bearer \",\n 'content-type': \"application/json\"\n}\n\nconn.request(\"POST\", \"/s2s/v2.0/file/hair-style\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v2.0/file/hair-style\"))\n .header(\"Authorization\", \"Bearer \")\n .header(\"content-type\", \"application/json\")\n .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\",\\\"file_size\\\":50000}]}\"))\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v2.0/task/template/hair-style": { "get": { "summary": "List predefined templates V2", "tags": [ "AI Hairstyle Generator" ], "security": [ { "BearerAuthenticationV2": [] } ], "parameters": [ { "name": "page_size", "in": "query", "schema": { "type": "integer", "example": 20 }, "description": "Number of results to return in this page. Valid value should be between 1 and 20. Default 20." }, { "name": "starting_token", "in": "query", "schema": { "type": "string", "example": 13045969587275114 }, "description": "Token for current page. Start with `null` for the first page, and use `next_token` from the previous response to start next page" } ], "responses": { "200": { "$ref": "#/components/responses/TemplateResponse" }, "400": { "$ref": "#/components/responses/InvalidParameters" }, "401": { "$ref": "#/components/responses/InvalidApiKey" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request GET \\\n --url 'https://yce-api-01.perfectcorp.com/s2s/v2.0/task/template/hair-style?page_size=20&starting_token=13045969587275114' \\\n --header 'Authorization: Bearer '" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'GET',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v2.0/task/template/hair-style?page_size=20&starting_token=13045969587275114',\n headers: {\n Authorization: 'Bearer '\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('GET', 'https://yce-api-01.perfectcorp.com/s2s/v2.0/task/template/hair-style?page_size=20&starting_token=13045969587275114');\nxhr.setRequestHeader('Authorization', 'Bearer ');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v2.0/task/template/hair-style?page_size=20&starting_token=13045969587275114\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\nheaders = { 'Authorization': \"Bearer \" }\n\nconn.request(\"GET\", \"/s2s/v2.0/task/template/hair-style?page_size=20&starting_token=13045969587275114\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v2.0/task/template/hair-style?page_size=20&starting_token=13045969587275114\"))\n .header(\"Authorization\", \"Bearer \")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v2.0/task/hair-style": { "post": { "summary": "Run an AI Hairstyle Generator task V2", "description": "Once you start an AI task, you need to keep polling at given polling_interval to check its status until it shows either success or error because if you don't, the task will time out and when you try to check the status later, you'll get an InvalidTaskId error even if the task did finish successfully and your units will still be consumed.", "tags": [ "AI Hairstyle Generator" ], "security": [ { "BearerAuthenticationV2": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RunWithSingleTemplateAndSrcUrl" } ] } } } }, "responses": { "200": { "description": "Successful execution of the AI Hairstyle Generator task", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BasicRunTaskResponseV2" } } } }, "400": { "description": "Failed execution of task", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RunError" } ] } } } }, "401": { "$ref": "#/components/responses/InvalidApiKey" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request POST \\\n --url https://yce-api-01.perfectcorp.com/s2s/v2.0/task/hair-style \\\n --header 'Authorization: Bearer ' \\\n --header 'content-type: application/json' \\\n --data '{\"src_file_url\":\"https://example.com/selfie.jpg\",\"src_file_id\":\"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE=\",\"template_id\":\"good_template_001\"}'" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'POST',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v2.0/task/hair-style',\n headers: {\n Authorization: 'Bearer ',\n 'content-type': 'application/json'\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n src_file_url: 'https://example.com/selfie.jpg',\n src_file_id: 'pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE=',\n template_id: 'good_template_001'\n}));\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = JSON.stringify({\n src_file_url: 'https://example.com/selfie.jpg',\n src_file_id: 'pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE=',\n template_id: 'good_template_001'\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('POST', 'https://yce-api-01.perfectcorp.com/s2s/v2.0/task/hair-style');\nxhr.setRequestHeader('Authorization', 'Bearer ');\nxhr.setRequestHeader('content-type', 'application/json');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v2.0/task/hair-style\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => json_encode([\n 'src_file_url' => 'https://example.com/selfie.jpg',\n 'src_file_id' => 'pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE=',\n 'template_id' => 'good_template_001'\n ]),\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\npayload = \"{\\\"src_file_url\\\":\\\"https://example.com/selfie.jpg\\\",\\\"src_file_id\\\":\\\"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE=\\\",\\\"template_id\\\":\\\"good_template_001\\\"}\"\n\nheaders = {\n 'Authorization': \"Bearer \",\n 'content-type': \"application/json\"\n}\n\nconn.request(\"POST\", \"/s2s/v2.0/task/hair-style\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v2.0/task/hair-style\"))\n .header(\"Authorization\", \"Bearer \")\n .header(\"content-type\", \"application/json\")\n .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"src_file_url\\\":\\\"https://example.com/selfie.jpg\\\",\\\"src_file_id\\\":\\\"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE=\\\",\\\"template_id\\\":\\\"good_template_001\\\"}\"))\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v2.0/task/hair-style/{task_id}": { "get": { "summary": "Check the status of a AI Hairstyle Generator task V2", "tags": [ "AI Hairstyle Generator" ], "security": [ { "BearerAuthenticationV2": [] } ], "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string", "example": "grH0CvsgXuAIHLUzD0V1Ol34hoet3R1tvdbtiVHrDb6_UqCLKIejAIajwxrhOAfe" }, "description": "ID of task to check" } ], "responses": { "200": { "description": "Successful check of the AI Hairstyle Generator task status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskStatusResponseV2" } } } }, "400": { "$ref": "#/components/responses/InvalidTaskId" }, "401": { "$ref": "#/components/responses/InvalidApiKey" }, "500": { "$ref": "#/components/responses/TaskTimeout" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request GET \\\n --url https://yce-api-01.perfectcorp.com/s2s/v2.0/task/hair-style/grH0CvsgXuAIHLUzD0V1Ol34hoet3R1tvdbtiVHrDb6_UqCLKIejAIajwxrhOAfe \\\n --header 'Authorization: Bearer '" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'GET',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v2.0/task/hair-style/grH0CvsgXuAIHLUzD0V1Ol34hoet3R1tvdbtiVHrDb6_UqCLKIejAIajwxrhOAfe',\n headers: {\n Authorization: 'Bearer '\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('GET', 'https://yce-api-01.perfectcorp.com/s2s/v2.0/task/hair-style/grH0CvsgXuAIHLUzD0V1Ol34hoet3R1tvdbtiVHrDb6_UqCLKIejAIajwxrhOAfe');\nxhr.setRequestHeader('Authorization', 'Bearer ');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v2.0/task/hair-style/grH0CvsgXuAIHLUzD0V1Ol34hoet3R1tvdbtiVHrDb6_UqCLKIejAIajwxrhOAfe\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\nheaders = { 'Authorization': \"Bearer \" }\n\nconn.request(\"GET\", \"/s2s/v2.0/task/hair-style/grH0CvsgXuAIHLUzD0V1Ol34hoet3R1tvdbtiVHrDb6_UqCLKIejAIajwxrhOAfe\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v2.0/task/hair-style/grH0CvsgXuAIHLUzD0V1Ol34hoet3R1tvdbtiVHrDb6_UqCLKIejAIajwxrhOAfe\"))\n .header(\"Authorization\", \"Bearer \")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.0/file/hair-ext": { "post": { "deprecated": true, "summary": "Create a new file.", "tags": [ "AI Hair Extension" ], "security": [ { "BearerAuthentication": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/File" } ] } } } }, "responses": { "200": { "description": "Successful retrieval of file upload information", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileResponse" } ] } } } }, "400": { "$ref": "#/components/responses/InvalidParameters" }, "401": { "$ref": "#/components/responses/InvalidAccessToken" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request POST \\\n --url https://yce-api-01.perfectcorp.com/s2s/v1.0/file/hair-ext \\\n --header 'Authorization: Bearer ' \\\n --header 'content-type: application/json' \\\n --data '{\"files\":[{\"content_type\":\"image/jpg\",\"file_name\":\"my-selfie.jpg\"}]}'" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'POST',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/file/hair-ext',\n headers: {\n Authorization: 'Bearer ',\n 'content-type': 'application/json'\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({files: [{content_type: 'image/jpg', file_name: 'my-selfie.jpg'}]}));\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = JSON.stringify({\n files: [\n {\n content_type: 'image/jpg',\n file_name: 'my-selfie.jpg'\n }\n ]\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('POST', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/file/hair-ext');\nxhr.setRequestHeader('Authorization', 'Bearer ');\nxhr.setRequestHeader('content-type', 'application/json');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/file/hair-ext\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => json_encode([\n 'files' => [\n [\n 'content_type' => 'image/jpg',\n 'file_name' => 'my-selfie.jpg'\n ]\n ]\n ]),\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\npayload = \"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\"}]}\"\n\nheaders = {\n 'Authorization': \"Bearer \",\n 'content-type': \"application/json\"\n}\n\nconn.request(\"POST\", \"/s2s/v1.0/file/hair-ext\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/file/hair-ext\"))\n .header(\"Authorization\", \"Bearer \")\n .header(\"content-type\", \"application/json\")\n .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\"}]}\"))\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.1/file/hair-ext": { "post": { "summary": "Create a new file.", "description": "To upload a new file, you'll first need to use the File API. It will give you a URL \u2013 use that URL to upload your file. Once the upload is finished, you can use the file_id from the same response to start using our AI features.", "tags": [ "AI Hair Extension" ], "security": [ { "BearerAuthentication": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileV1.1" } ] } } } }, "responses": { "200": { "description": "Successful retrieval of file upload information", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileResponse" } ] } } } }, "400": { "$ref": "#/components/responses/InvalidParameters" }, "401": { "$ref": "#/components/responses/InvalidAccessToken" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request POST \\\n --url https://yce-api-01.perfectcorp.com/s2s/v1.1/file/hair-ext \\\n --header 'Authorization: Bearer ' \\\n --header 'content-type: application/json' \\\n --data '{\"files\":[{\"content_type\":\"image/jpg\",\"file_name\":\"my-selfie.jpg\",\"file_size\":50000}]}'" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'POST',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.1/file/hair-ext',\n headers: {\n Authorization: 'Bearer ',\n 'content-type': 'application/json'\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n files: [{content_type: 'image/jpg', file_name: 'my-selfie.jpg', file_size: 50000}]\n}));\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = JSON.stringify({\n files: [\n {\n content_type: 'image/jpg',\n file_name: 'my-selfie.jpg',\n file_size: 50000\n }\n ]\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('POST', 'https://yce-api-01.perfectcorp.com/s2s/v1.1/file/hair-ext');\nxhr.setRequestHeader('Authorization', 'Bearer ');\nxhr.setRequestHeader('content-type', 'application/json');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.1/file/hair-ext\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => json_encode([\n 'files' => [\n [\n 'content_type' => 'image/jpg',\n 'file_name' => 'my-selfie.jpg',\n 'file_size' => 50000\n ]\n ]\n ]),\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\npayload = \"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\",\\\"file_size\\\":50000}]}\"\n\nheaders = {\n 'Authorization': \"Bearer \",\n 'content-type': \"application/json\"\n}\n\nconn.request(\"POST\", \"/s2s/v1.1/file/hair-ext\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.1/file/hair-ext\"))\n .header(\"Authorization\", \"Bearer \")\n .header(\"content-type\", \"application/json\")\n .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\",\\\"file_size\\\":50000}]}\"))\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.0/task/style-group/hair-ext": { "get": { "summary": "List predefined style groups for AI Hair Extension task", "tags": [ "AI Hair Extension" ], "security": [ { "BearerAuthentication": [] } ], "parameters": [ { "name": "page_size", "in": "query", "schema": { "type": "integer", "example": 20 }, "description": "Number of results to return in this page. Valid value should be between 1 and 20. Default 20." }, { "name": "starting_token", "in": "query", "schema": { "type": "string", "example": 13045969587275114 }, "description": "Token for current page. Start with `null` for the first page, and use `next_token` from the previous response to start next page" } ], "responses": { "200": { "description": "Successful retrieval of hair extension style groups", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Response status", "example": 200 }, "result": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Token to query next page.", "example": 13045969587275114 }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID of style group", "example": 18213963761051864 }, "info": { "type": "object", "properties": { "title": { "type": "string", "description": "Title of this style group", "example": "Female" } } } } } } } } } } } } }, "400": { "$ref": "#/components/responses/InvalidParameters" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request GET \\\n --url 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/style-group/hair-ext?page_size=20&starting_token=13045969587275114' \\\n --header 'Authorization: Bearer '" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'GET',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/task/style-group/hair-ext?page_size=20&starting_token=13045969587275114',\n headers: {\n Authorization: 'Bearer '\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('GET', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/style-group/hair-ext?page_size=20&starting_token=13045969587275114');\nxhr.setRequestHeader('Authorization', 'Bearer ');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/style-group/hair-ext?page_size=20&starting_token=13045969587275114\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\nheaders = { 'Authorization': \"Bearer \" }\n\nconn.request(\"GET\", \"/s2s/v1.0/task/style-group/hair-ext?page_size=20&starting_token=13045969587275114\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/style-group/hair-ext?page_size=20&starting_token=13045969587275114\"))\n .header(\"Authorization\", \"Bearer \")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.0/task/style/hair-ext": { "get": { "summary": "List predefined style for AI Hair Extension task", "tags": [ "AI Hair Extension" ], "security": [ { "BearerAuthentication": [] } ], "parameters": [ { "name": "page_size", "in": "query", "schema": { "type": "integer", "example": 20 }, "description": "Number of results to return in this page. Valid value should be between 1 and 20. Default 20." }, { "name": "starting_token", "in": "query", "schema": { "type": "string", "example": 13045969587275114 }, "description": "Token for current page. Start with `null` for the first page, and use `next_token` from the previous response to start next page" }, { "name": "style_group_id", "in": "query", "required": true, "schema": { "type": "integer", "example": 18213963761051864 }, "description": "The id of style group" } ], "responses": { "200": { "description": "Successful retrieval of hair extension styles", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Response status", "example": 200 }, "result": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Token to query next page.", "example": 13045969587275114 }, "styles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID of style", "example": 22205685004925400 }, "info": { "type": "object", "properties": { "title": { "type": "string", "description": "Title of this style", "example": "Long Wave" }, "thumb": { "type": "string", "description": "Thumbnail url for this parameter", "example": "https://yce.perfectcorp.com/static/prompt/female/long_wave.jpg" } } } } } } } } } } } } }, "400": { "$ref": "#/components/responses/InvalidParameters" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request GET \\\n --url 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/style/hair-ext?page_size=20&starting_token=13045969587275114&style_group_id=18213963761051864' \\\n --header 'Authorization: Bearer '" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'GET',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/task/style/hair-ext?page_size=20&starting_token=13045969587275114&style_group_id=18213963761051864',\n headers: {\n Authorization: 'Bearer '\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('GET', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/style/hair-ext?page_size=20&starting_token=13045969587275114&style_group_id=18213963761051864');\nxhr.setRequestHeader('Authorization', 'Bearer ');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/style/hair-ext?page_size=20&starting_token=13045969587275114&style_group_id=18213963761051864\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\nheaders = { 'Authorization': \"Bearer \" }\n\nconn.request(\"GET\", \"/s2s/v1.0/task/style/hair-ext?page_size=20&starting_token=13045969587275114&style_group_id=18213963761051864\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/style/hair-ext?page_size=20&starting_token=13045969587275114&style_group_id=18213963761051864\"))\n .header(\"Authorization\", \"Bearer \")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.1/task/style/hair-ext": { "get": { "summary": "List predefined style by category", "tags": [ "AI Hair Extension" ], "security": [ { "BearerAuthentication": [] } ], "parameters": [ { "$ref": "#/components/parameters/CategoryId" } ], "responses": { "200": { "$ref": "#/components/responses/StyleResponse_V1.1" }, "400": { "$ref": "#/components/responses/InvalidParameters" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request GET \\\n --url 'https://yce-api-01.perfectcorp.com/s2s/v1.1/task/style/hair-ext?category_id=SOME_ARRAY_VALUE' \\\n --header 'Authorization: Bearer '" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'GET',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.1/task/style/hair-ext?category_id=SOME_ARRAY_VALUE',\n headers: {\n Authorization: 'Bearer '\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('GET', 'https://yce-api-01.perfectcorp.com/s2s/v1.1/task/style/hair-ext?category_id=SOME_ARRAY_VALUE');\nxhr.setRequestHeader('Authorization', 'Bearer ');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.1/task/style/hair-ext?category_id=SOME_ARRAY_VALUE\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\nheaders = { 'Authorization': \"Bearer \" }\n\nconn.request(\"GET\", \"/s2s/v1.1/task/style/hair-ext?category_id=SOME_ARRAY_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.1/task/style/hair-ext?category_id=SOME_ARRAY_VALUE\"))\n .header(\"Authorization\", \"Bearer \")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.0/task/hair-ext": { "post": { "summary": "Run an AI Hair Extension task", "description": "Once you start an AI task, you need to keep polling at given polling_interval to check its status until it shows either success or error because if you don't, the task will time out and when you try to check the status later, you'll get an InvalidTaskId error even if the task did finish successfully and your units will still be consumed.", "tags": [ "AI Hair Extension" ], "security": [ { "BearerAuthentication": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RunWithSingleStyle" }, { "properties": { "payload": { "type": "object", "required": [ "file_sets" ], "properties": { "file_sets": { "type": "object", "required": [ "src_ids" ], "properties": { "src_ids": { "type": "array", "description": "ID of file to apply hair extension. File ID from upload file API", "items": { "type": "string" } } } } } } } } ] } } } }, "responses": { "200": { "description": "Successful execution of the AI Hair Extension task", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Response status", "example": 200 }, "result": { "type": "object", "properties": { "task_id": { "type": "string", "description": "ID of this task. This `task_id` will only valid if client continue polling check status API with interval `polling_interval` defined in check status API response. Otherwise, engine might consider client have leave and will not process the task. No unit will be consumed in this case.", "example": "SX9ALF1Z+KIiNa+GaFRp4bI5gijoc/ckI2teebLq35Bo1Nwc++3iXXdKqnU4/LID" } } } } } } } }, "400": { "description": "Failed execution of task", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RunError" } ] } } } }, "401": { "$ref": "#/components/responses/InvalidAccessToken" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request POST \\\n --url https://yce-api-01.perfectcorp.com/s2s/v1.0/task/hair-ext \\\n --header 'Authorization: Bearer ' \\\n --header 'content-type: application/json' \\\n --data '{\"request_id\":0,\"payload\":{\"actions\":[{\"id\":0,\"params\":{\"style_group_id\":18213963761051864,\"style_ids\":[22205685004925400]}}],\"file_sets\":{\"src_ids\":[\"string\"]}}}'" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'POST',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/task/hair-ext',\n headers: {\n Authorization: 'Bearer ',\n 'content-type': 'application/json'\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n request_id: 0,\n payload: {\n actions: [\n {\n id: 0,\n params: {style_group_id: 18213963761051864, style_ids: [22205685004925400]}\n }\n ],\n file_sets: {src_ids: ['string']}\n }\n}));\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = JSON.stringify({\n request_id: 0,\n payload: {\n actions: [\n {\n id: 0,\n params: {\n style_group_id: 18213963761051864,\n style_ids: [\n 22205685004925400\n ]\n }\n }\n ],\n file_sets: {\n src_ids: [\n 'string'\n ]\n }\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('POST', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/hair-ext');\nxhr.setRequestHeader('Authorization', 'Bearer ');\nxhr.setRequestHeader('content-type', 'application/json');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/hair-ext\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => json_encode([\n 'request_id' => 0,\n 'payload' => [\n 'actions' => [\n [\n 'id' => 0,\n 'params' => [\n 'style_group_id' => 18213963761051864,\n 'style_ids' => [\n 22205685004925400\n ]\n ]\n ]\n ],\n 'file_sets' => [\n 'src_ids' => [\n 'string'\n ]\n ]\n ]\n ]),\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\npayload = \"{\\\"request_id\\\":0,\\\"payload\\\":{\\\"actions\\\":[{\\\"id\\\":0,\\\"params\\\":{\\\"style_group_id\\\":18213963761051864,\\\"style_ids\\\":[22205685004925400]}}],\\\"file_sets\\\":{\\\"src_ids\\\":[\\\"string\\\"]}}}\"\n\nheaders = {\n 'Authorization': \"Bearer \",\n 'content-type': \"application/json\"\n}\n\nconn.request(\"POST\", \"/s2s/v1.0/task/hair-ext\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/hair-ext\"))\n .header(\"Authorization\", \"Bearer \")\n .header(\"content-type\", \"application/json\")\n .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"request_id\\\":0,\\\"payload\\\":{\\\"actions\\\":[{\\\"id\\\":0,\\\"params\\\":{\\\"style_group_id\\\":18213963761051864,\\\"style_ids\\\":[22205685004925400]}}],\\\"file_sets\\\":{\\\"src_ids\\\":[\\\"string\\\"]}}}\"))\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] }, "get": { "summary": "Check the status of a AI Hair Extension task", "tags": [ "AI Hair Extension" ], "security": [ { "BearerAuthentication": [] } ], "parameters": [ { "name": "task_id", "in": "query", "required": true, "schema": { "type": "string", "example": "SX9ALF1Z+KIiNa+GaFRp4bI5gijoc/ckI2teebLq35Bo1Nwc++3iXXdKqnU4/LID" }, "description": "ID of task to check" } ], "responses": { "200": { "description": "Successful check of the AI Hair Extension task status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskStatusResponse" } } } }, "400": { "$ref": "#/components/responses/InvalidTaskId" }, "401": { "$ref": "#/components/responses/InvalidAccessToken" }, "500": { "$ref": "#/components/responses/TaskTimeout" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request GET \\\n --url 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/hair-ext?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID' \\\n --header 'Authorization: Bearer '" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'GET',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/task/hair-ext?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID',\n headers: {\n Authorization: 'Bearer '\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('GET', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/hair-ext?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID');\nxhr.setRequestHeader('Authorization', 'Bearer ');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/hair-ext?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\nheaders = { 'Authorization': \"Bearer \" }\n\nconn.request(\"GET\", \"/s2s/v1.0/task/hair-ext?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/hair-ext?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID\"))\n .header(\"Authorization\", \"Bearer \")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.0/file/hair-bang": { "post": { "deprecated": true, "summary": "Create a new file.", "tags": [ "AI Hair Bang Generator" ], "security": [ { "BearerAuthentication": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/File" } ] } } } }, "responses": { "200": { "description": "Successful retrieval of file upload information", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileResponse" } ] } } } }, "400": { "$ref": "#/components/responses/InvalidParameters" }, "401": { "$ref": "#/components/responses/InvalidAccessToken" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request POST \\\n --url https://yce-api-01.perfectcorp.com/s2s/v1.0/file/hair-bang \\\n --header 'Authorization: Bearer ' \\\n --header 'content-type: application/json' \\\n --data '{\"files\":[{\"content_type\":\"image/jpg\",\"file_name\":\"my-selfie.jpg\"}]}'" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'POST',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/file/hair-bang',\n headers: {\n Authorization: 'Bearer ',\n 'content-type': 'application/json'\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({files: [{content_type: 'image/jpg', file_name: 'my-selfie.jpg'}]}));\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = JSON.stringify({\n files: [\n {\n content_type: 'image/jpg',\n file_name: 'my-selfie.jpg'\n }\n ]\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('POST', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/file/hair-bang');\nxhr.setRequestHeader('Authorization', 'Bearer ');\nxhr.setRequestHeader('content-type', 'application/json');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/file/hair-bang\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => json_encode([\n 'files' => [\n [\n 'content_type' => 'image/jpg',\n 'file_name' => 'my-selfie.jpg'\n ]\n ]\n ]),\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\npayload = \"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\"}]}\"\n\nheaders = {\n 'Authorization': \"Bearer \",\n 'content-type': \"application/json\"\n}\n\nconn.request(\"POST\", \"/s2s/v1.0/file/hair-bang\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/file/hair-bang\"))\n .header(\"Authorization\", \"Bearer \")\n .header(\"content-type\", \"application/json\")\n .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\"}]}\"))\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.1/file/hair-bang": { "post": { "summary": "Create a new file.", "description": "To upload a new file, you'll first need to use the File API. It will give you a URL \u2013 use that URL to upload your file. Once the upload is finished, you can use the file_id from the same response to start using our AI features.", "tags": [ "AI Hair Bang Generator" ], "security": [ { "BearerAuthentication": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileV1.1" } ] } } } }, "responses": { "200": { "description": "Successful retrieval of file upload information", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileResponse" } ] } } } }, "400": { "$ref": "#/components/responses/InvalidParameters" }, "401": { "$ref": "#/components/responses/InvalidAccessToken" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request POST \\\n --url https://yce-api-01.perfectcorp.com/s2s/v1.1/file/hair-bang \\\n --header 'Authorization: Bearer ' \\\n --header 'content-type: application/json' \\\n --data '{\"files\":[{\"content_type\":\"image/jpg\",\"file_name\":\"my-selfie.jpg\",\"file_size\":50000}]}'" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'POST',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.1/file/hair-bang',\n headers: {\n Authorization: 'Bearer ',\n 'content-type': 'application/json'\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n files: [{content_type: 'image/jpg', file_name: 'my-selfie.jpg', file_size: 50000}]\n}));\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = JSON.stringify({\n files: [\n {\n content_type: 'image/jpg',\n file_name: 'my-selfie.jpg',\n file_size: 50000\n }\n ]\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('POST', 'https://yce-api-01.perfectcorp.com/s2s/v1.1/file/hair-bang');\nxhr.setRequestHeader('Authorization', 'Bearer ');\nxhr.setRequestHeader('content-type', 'application/json');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.1/file/hair-bang\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => json_encode([\n 'files' => [\n [\n 'content_type' => 'image/jpg',\n 'file_name' => 'my-selfie.jpg',\n 'file_size' => 50000\n ]\n ]\n ]),\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\npayload = \"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\",\\\"file_size\\\":50000}]}\"\n\nheaders = {\n 'Authorization': \"Bearer \",\n 'content-type': \"application/json\"\n}\n\nconn.request(\"POST\", \"/s2s/v1.1/file/hair-bang\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.1/file/hair-bang\"))\n .header(\"Authorization\", \"Bearer \")\n .header(\"content-type\", \"application/json\")\n .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\",\\\"file_size\\\":50000}]}\"))\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.0/task/style-group/hair-bang": { "get": { "summary": "List predefined style groups for AI Hair Bang Generator task", "tags": [ "AI Hair Bang Generator" ], "security": [ { "BearerAuthentication": [] } ], "parameters": [ { "name": "page_size", "in": "query", "schema": { "type": "integer", "example": 20 }, "description": "Number of results to return in this page. Valid value should be between 1 and 20. Default 20." }, { "name": "starting_token", "in": "query", "schema": { "type": "string", "example": 13045969587275114 }, "description": "Token for current page. Start with `null` for the first page, and use `next_token` from the previous response to start next page" } ], "responses": { "200": { "description": "Successful retrieval of hair bang generator style groups", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Response status", "example": 200 }, "result": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Token to query next page.", "example": 13045969587275114 }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID of style group", "example": 18213963761051864 }, "info": { "type": "object", "properties": { "title": { "type": "string", "description": "Title of this style group", "example": "Female" } } } } } } } } } } } } }, "400": { "$ref": "#/components/responses/InvalidParameters" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request GET \\\n --url 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/style-group/hair-bang?page_size=20&starting_token=13045969587275114' \\\n --header 'Authorization: Bearer '" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'GET',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/task/style-group/hair-bang?page_size=20&starting_token=13045969587275114',\n headers: {\n Authorization: 'Bearer '\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('GET', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/style-group/hair-bang?page_size=20&starting_token=13045969587275114');\nxhr.setRequestHeader('Authorization', 'Bearer ');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/style-group/hair-bang?page_size=20&starting_token=13045969587275114\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\nheaders = { 'Authorization': \"Bearer \" }\n\nconn.request(\"GET\", \"/s2s/v1.0/task/style-group/hair-bang?page_size=20&starting_token=13045969587275114\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/style-group/hair-bang?page_size=20&starting_token=13045969587275114\"))\n .header(\"Authorization\", \"Bearer \")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.0/task/style/hair-bang": { "get": { "summary": "List predefined style for AI Hair Bang Generator task", "tags": [ "AI Hair Bang Generator" ], "security": [ { "BearerAuthentication": [] } ], "parameters": [ { "name": "page_size", "in": "query", "schema": { "type": "integer", "example": 20 }, "description": "Number of results to return in this page. Valid value should be between 1 and 20. Default 20." }, { "name": "starting_token", "in": "query", "schema": { "type": "string", "example": 13045969587275114 }, "description": "Token for current page. Start with `null` for the first page, and use `next_token` from the previous response to start next page" }, { "name": "style_group_id", "in": "query", "required": true, "schema": { "type": "integer", "example": 18213963761051864 }, "description": "The id of style group" } ], "responses": { "200": { "description": "Successful retrieval of hair bang generator styles", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Response status", "example": 200 }, "result": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Token to query next page.", "example": 13045969587275114 }, "styles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID of style", "example": 22205685004925400 }, "info": { "type": "object", "properties": { "title": { "type": "string", "description": "Title of this style", "example": "Long Wave" }, "thumb": { "type": "string", "description": "Thumbnail url for this parameter", "example": "https://yce.perfectcorp.com/static/prompt/female/long_wave.jpg" } } } } } } } } } } } } }, "400": { "$ref": "#/components/responses/InvalidParameters" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request GET \\\n --url 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/style/hair-bang?page_size=20&starting_token=13045969587275114&style_group_id=18213963761051864' \\\n --header 'Authorization: Bearer '" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'GET',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/task/style/hair-bang?page_size=20&starting_token=13045969587275114&style_group_id=18213963761051864',\n headers: {\n Authorization: 'Bearer '\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('GET', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/style/hair-bang?page_size=20&starting_token=13045969587275114&style_group_id=18213963761051864');\nxhr.setRequestHeader('Authorization', 'Bearer ');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/style/hair-bang?page_size=20&starting_token=13045969587275114&style_group_id=18213963761051864\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\nheaders = { 'Authorization': \"Bearer \" }\n\nconn.request(\"GET\", \"/s2s/v1.0/task/style/hair-bang?page_size=20&starting_token=13045969587275114&style_group_id=18213963761051864\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/style/hair-bang?page_size=20&starting_token=13045969587275114&style_group_id=18213963761051864\"))\n .header(\"Authorization\", \"Bearer \")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.1/task/style/hair-bang": { "get": { "summary": "List predefined style by category", "tags": [ "AI Hair Bang Generator" ], "security": [ { "BearerAuthentication": [] } ], "parameters": [ { "$ref": "#/components/parameters/CategoryId" } ], "responses": { "200": { "$ref": "#/components/responses/StyleResponse_V1.1" }, "400": { "$ref": "#/components/responses/InvalidParameters" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request GET \\\n --url 'https://yce-api-01.perfectcorp.com/s2s/v1.1/task/style/hair-bang?category_id=SOME_ARRAY_VALUE' \\\n --header 'Authorization: Bearer '" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'GET',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.1/task/style/hair-bang?category_id=SOME_ARRAY_VALUE',\n headers: {\n Authorization: 'Bearer '\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('GET', 'https://yce-api-01.perfectcorp.com/s2s/v1.1/task/style/hair-bang?category_id=SOME_ARRAY_VALUE');\nxhr.setRequestHeader('Authorization', 'Bearer ');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.1/task/style/hair-bang?category_id=SOME_ARRAY_VALUE\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\nheaders = { 'Authorization': \"Bearer \" }\n\nconn.request(\"GET\", \"/s2s/v1.1/task/style/hair-bang?category_id=SOME_ARRAY_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.1/task/style/hair-bang?category_id=SOME_ARRAY_VALUE\"))\n .header(\"Authorization\", \"Bearer \")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.0/task/hair-bang": { "post": { "summary": "Run an AI Hair Bang Generator task", "description": "Once you start an AI task, you need to keep polling at given polling_interval to check its status until it shows either success or error because if you don't, the task will time out and when you try to check the status later, you'll get an InvalidTaskId error even if the task did finish successfully and your units will still be consumed.", "tags": [ "AI Hair Bang Generator" ], "security": [ { "BearerAuthentication": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RunWithSingleStyle" }, { "properties": { "payload": { "type": "object", "required": [ "file_sets" ], "properties": { "file_sets": { "type": "object", "required": [ "src_ids" ], "properties": { "src_ids": { "type": "array", "description": "ID of file to apply hair bang generator. File ID from upload file API", "items": { "type": "string" } } } } } } } } ] } } } }, "responses": { "200": { "description": "Successful execution of the AI Hair Bang Generator task", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Response status", "example": 200 }, "result": { "type": "object", "properties": { "task_id": { "type": "string", "description": "ID of this task. This `task_id` will only valid if client continue polling check status API with interval `polling_interval` defined in check status API response. Otherwise, engine might consider client have leave and will not process the task. No unit will be consumed in this case.", "example": "SX9ALF1Z+KIiNa+GaFRp4bI5gijoc/ckI2teebLq35Bo1Nwc++3iXXdKqnU4/LID" } } } } } } } }, "400": { "description": "Failed execution of task", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RunError" } ] } } } }, "401": { "$ref": "#/components/responses/InvalidAccessToken" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request POST \\\n --url https://yce-api-01.perfectcorp.com/s2s/v1.0/task/hair-bang \\\n --header 'Authorization: Bearer ' \\\n --header 'content-type: application/json' \\\n --data '{\"request_id\":0,\"payload\":{\"actions\":[{\"id\":0,\"params\":{\"style_group_id\":18213963761051864,\"style_ids\":[22205685004925400]}}],\"file_sets\":{\"src_ids\":[\"string\"]}}}'" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'POST',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/task/hair-bang',\n headers: {\n Authorization: 'Bearer ',\n 'content-type': 'application/json'\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n request_id: 0,\n payload: {\n actions: [\n {\n id: 0,\n params: {style_group_id: 18213963761051864, style_ids: [22205685004925400]}\n }\n ],\n file_sets: {src_ids: ['string']}\n }\n}));\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = JSON.stringify({\n request_id: 0,\n payload: {\n actions: [\n {\n id: 0,\n params: {\n style_group_id: 18213963761051864,\n style_ids: [\n 22205685004925400\n ]\n }\n }\n ],\n file_sets: {\n src_ids: [\n 'string'\n ]\n }\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('POST', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/hair-bang');\nxhr.setRequestHeader('Authorization', 'Bearer ');\nxhr.setRequestHeader('content-type', 'application/json');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/hair-bang\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => json_encode([\n 'request_id' => 0,\n 'payload' => [\n 'actions' => [\n [\n 'id' => 0,\n 'params' => [\n 'style_group_id' => 18213963761051864,\n 'style_ids' => [\n 22205685004925400\n ]\n ]\n ]\n ],\n 'file_sets' => [\n 'src_ids' => [\n 'string'\n ]\n ]\n ]\n ]),\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\npayload = \"{\\\"request_id\\\":0,\\\"payload\\\":{\\\"actions\\\":[{\\\"id\\\":0,\\\"params\\\":{\\\"style_group_id\\\":18213963761051864,\\\"style_ids\\\":[22205685004925400]}}],\\\"file_sets\\\":{\\\"src_ids\\\":[\\\"string\\\"]}}}\"\n\nheaders = {\n 'Authorization': \"Bearer \",\n 'content-type': \"application/json\"\n}\n\nconn.request(\"POST\", \"/s2s/v1.0/task/hair-bang\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/hair-bang\"))\n .header(\"Authorization\", \"Bearer \")\n .header(\"content-type\", \"application/json\")\n .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"request_id\\\":0,\\\"payload\\\":{\\\"actions\\\":[{\\\"id\\\":0,\\\"params\\\":{\\\"style_group_id\\\":18213963761051864,\\\"style_ids\\\":[22205685004925400]}}],\\\"file_sets\\\":{\\\"src_ids\\\":[\\\"string\\\"]}}}\"))\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] }, "get": { "summary": "Check the status of a AI Hair Bang Generator task", "tags": [ "AI Hair Bang Generator" ], "security": [ { "BearerAuthentication": [] } ], "parameters": [ { "name": "task_id", "in": "query", "required": true, "schema": { "type": "string", "example": "SX9ALF1Z+KIiNa+GaFRp4bI5gijoc/ckI2teebLq35Bo1Nwc++3iXXdKqnU4/LID" }, "description": "ID of task to check" } ], "responses": { "200": { "description": "Successful check of the AI Hair Bang Generator task status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskStatusResponse" } } } }, "400": { "$ref": "#/components/responses/InvalidTaskId" }, "401": { "$ref": "#/components/responses/InvalidAccessToken" }, "500": { "$ref": "#/components/responses/TaskTimeout" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request GET \\\n --url 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/hair-bang?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID' \\\n --header 'Authorization: Bearer '" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'GET',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/task/hair-bang?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID',\n headers: {\n Authorization: 'Bearer '\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('GET', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/task/hair-bang?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID');\nxhr.setRequestHeader('Authorization', 'Bearer ');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/hair-bang?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\nheaders = { 'Authorization': \"Bearer \" }\n\nconn.request(\"GET\", \"/s2s/v1.0/task/hair-bang?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/task/hair-bang?task_id=SX9ALF1Z%2BKIiNa%2BGaFRp4bI5gijoc%2FckI2teebLq35Bo1Nwc%2B%2B3iXXdKqnU4%2FLID\"))\n .header(\"Authorization\", \"Bearer \")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.0/file/hair-vol": { "post": { "deprecated": true, "summary": "Create a new file.", "tags": [ "AI Hair Volume Generator" ], "security": [ { "BearerAuthentication": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/File" } ] } } } }, "responses": { "200": { "description": "Successful retrieval of file upload information", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileResponse" } ] } } } }, "400": { "$ref": "#/components/responses/InvalidParameters" }, "401": { "$ref": "#/components/responses/InvalidAccessToken" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request POST \\\n --url https://yce-api-01.perfectcorp.com/s2s/v1.0/file/hair-vol \\\n --header 'Authorization: Bearer ' \\\n --header 'content-type: application/json' \\\n --data '{\"files\":[{\"content_type\":\"image/jpg\",\"file_name\":\"my-selfie.jpg\"}]}'" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'POST',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.0/file/hair-vol',\n headers: {\n Authorization: 'Bearer ',\n 'content-type': 'application/json'\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({files: [{content_type: 'image/jpg', file_name: 'my-selfie.jpg'}]}));\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = JSON.stringify({\n files: [\n {\n content_type: 'image/jpg',\n file_name: 'my-selfie.jpg'\n }\n ]\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('POST', 'https://yce-api-01.perfectcorp.com/s2s/v1.0/file/hair-vol');\nxhr.setRequestHeader('Authorization', 'Bearer ');\nxhr.setRequestHeader('content-type', 'application/json');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.0/file/hair-vol\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => json_encode([\n 'files' => [\n [\n 'content_type' => 'image/jpg',\n 'file_name' => 'my-selfie.jpg'\n ]\n ]\n ]),\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\npayload = \"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\"}]}\"\n\nheaders = {\n 'Authorization': \"Bearer \",\n 'content-type': \"application/json\"\n}\n\nconn.request(\"POST\", \"/s2s/v1.0/file/hair-vol\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))" }, { "lang": "java_nethttp", "label": "Java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://yce-api-01.perfectcorp.com/s2s/v1.0/file/hair-vol\"))\n .header(\"Authorization\", \"Bearer \")\n .header(\"content-type\", \"application/json\")\n .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\"}]}\"))\n .build();\nHttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" } ] } }, "/s2s/v1.1/file/hair-vol": { "post": { "summary": "Create a new file.", "description": "To upload a new file, you'll first need to use the File API. It will give you a URL \u2013 use that URL to upload your file. Once the upload is finished, you can use the file_id from the same response to start using our AI features.", "tags": [ "AI Hair Volume Generator" ], "security": [ { "BearerAuthentication": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileV1.1" } ] } } } }, "responses": { "200": { "description": "Successful retrieval of file upload information", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileResponse" } ] } } } }, "400": { "$ref": "#/components/responses/InvalidParameters" }, "401": { "$ref": "#/components/responses/InvalidAccessToken" } }, "x-codeSamples": [ { "lang": "shell_curl", "label": "curl", "source": "curl --request POST \\\n --url https://yce-api-01.perfectcorp.com/s2s/v1.1/file/hair-vol \\\n --header 'Authorization: Bearer ' \\\n --header 'content-type: application/json' \\\n --data '{\"files\":[{\"content_type\":\"image/jpg\",\"file_name\":\"my-selfie.jpg\",\"file_size\":50000}]}'" }, { "lang": "node_native", "label": "Node.js", "source": "const http = require('https');\n\nconst options = {\n method: 'POST',\n hostname: 'yce-api-01.perfectcorp.com',\n port: null,\n path: '/s2s/v1.1/file/hair-vol',\n headers: {\n Authorization: 'Bearer ',\n 'content-type': 'application/json'\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on('data', function (chunk) {\n chunks.push(chunk);\n });\n\n res.on('end', function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n files: [{content_type: 'image/jpg', file_name: 'my-selfie.jpg', file_size: 50000}]\n}));\nreq.end();" }, { "lang": "javascript_xhr", "label": "JavaScript", "source": "const data = JSON.stringify({\n files: [\n {\n content_type: 'image/jpg',\n file_name: 'my-selfie.jpg',\n file_size: 50000\n }\n ]\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open('POST', 'https://yce-api-01.perfectcorp.com/s2s/v1.1/file/hair-vol');\nxhr.setRequestHeader('Authorization', 'Bearer ');\nxhr.setRequestHeader('content-type', 'application/json');\n\nxhr.send(data);" }, { "lang": "php_curl", "label": "PHP", "source": " \"https://yce-api-01.perfectcorp.com/s2s/v1.1/file/hair-vol\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => json_encode([\n 'files' => [\n [\n 'content_type' => 'image/jpg',\n 'file_name' => 'my-selfie.jpg',\n 'file_size' => 50000\n ]\n ]\n ]),\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer \",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n\n?>" }, { "lang": "python_python3", "label": "Python", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"yce-api-01.perfectcorp.com\")\n\npayload = \"{\\\"files\\\":[{\\\"content_type\\\":\\\"image/jpg\\\",\\\"file_name\\\":\\\"my-selfie.jpg\\\",\\\"file_size\\\":50000}]}\"\n\nheaders = {\n 'Authorization': \"Bearer