YouCam Online Editor AI APIs (1.20 857ae8f)

Last modified: Apr. 10, 2025 857ae8f

The 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.

PLEASE 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, and Terms of Service. And If you have any issue, please contact: YouCamOnlineEditor_API@perfectcorp.com

YouCam Online Editor 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.

The 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.

• YouCam Online Editor AI API server:

  https://yce-api-01.perfectcorp.com

To ensure fair usage and prevent abuse, our API implements rate limiting. There are two types of rate limits:

• Per IP Address

  Each IP address is allowed a maximum of 100 requests per 5 minutes. If this limit is exceeded, subsequent requests will receive a 429 Too Many Requests error.

• Per Access Token

  Each access token is allowed a maximum of 100 requests per minute. If this limit is exceeded, subsequent requests will receive a 429 Too Many Requests error.

Both 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 credit will be processed real-time. Other APIs can use the access token util expired.

It is recommended that you handle rate limit errors gracefully in your application by implementing the appropriate backoff and retry mechanisms.

First, you need to register a YouCam Online Editor account for free at https://yce.perfectcorp.com/. You can then purchase or subscribe to get your credits to use the service. You can see your subscription plan, pay as you go credits, and your usage record at https://yce.perfectcorp.com/account. 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.

To complete the authentication and start using the AI APIs, you need:

1. Go to https://yce.perfectcorp.com/account/apikey and create the API Key.

2. 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.

   

   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.

3. To obtain id_token, you need to follow the method below and convert client_secret into id_token

   Encrypt

   client_id=<client_id>&timestamp=<timestamp in millisecond>

   with RSA X.509 format Base64 encoded client_secret to obtain id_token

   JavaScript sample:

   let encrypt = new JSEncrypt();
   encrypt.setPublicKey(client_secret);
   let encrypted = encrypt.encrypt(
   `client_id=${client_id}&timestamp=${new Date().getTime()}`
   );
   console.log(encrypted);
   

   PHP sample:

   <?php
   class RSAPublicEncryption {
       private $publicKey;
   
       public function __construct($rawPublicKey) {
           $pemKey = "-----BEGIN PUBLIC KEY-----\n" .
                   chunk_split($rawPublicKey, 64, "\n") .
                   "-----END PUBLIC KEY-----";
   
           $this->publicKey = openssl_pkey_get_public($pemKey);
           if ($this->publicKey === false) {
               throw new Exception('Invalid public key');
           }
       }
   
       public function encrypt($data) {
           $encrypted = '';
           $result = openssl_public_encrypt($data, $encrypted, $this->publicKey);
           if ($result === false) {
               throw new Exception('Encryption failed');
           }
           return base64_encode($encrypted);
       }
   }
   
   try {
       $rawPublicKey = "<client_secret>";
   
       $rsa = new RSAPublicEncryption($rawPublicKey);
   
       $data = "client_id=<client_id>&timestamp=<timestamp in millisecond>";
   
       $encrypted = $rsa->encrypt($data);
       echo "Encrypted: " . $encrypted . "\n";
   
   } catch (Exception $e) {
       echo "Error: " . $e->getMessage();
   }
   ?>
   

4. Calling the authentication API to obtain the access_token to start using the YouCam Online Editor AI APIs.

Please note that your credits will be consumed when the resulting image was successfully generated. You may refer to the pricing page regarding the price of each task and how to obtain credits.

Now, let's consider an example usage flow of an AI Photo Enhance API calling sequence. After successfully authorizing and getting the access_token, you can call 'file/enhance' to acquire the upload URL and a File ID associated with it. So that You can upload your photo to the upload URL and use the File ID to run a AI task.

Subsequently, calling POST 'task/enhance' with the File ID executes the enhance task and obtains a task_id.

This 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 credits will be consumed during this stage.

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 credit(s) will be consumed).

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.

The task will change to the 'success' status after the engine successfully processes your input file and generates the resulting image. Your credits 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 credits will be consumed.

When deducting credits, the system will prioritize those nearing expiration. If the expiration date is the same, it will deduct the credits obtained on the earliest date.

Any files you upload are stored on our server for one day, and then they're automatically deleted. Files created by the system – the results you get – we keep those for 30 days before they're automatically removed.

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 – you can use that ID with another feature to get it.

• Successful responses (100 - 399)
• Client error responses (400 - 499)
• Server error response (500 - 599)

Q: Why am I getting InvalidTaskId error?

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.

Q: What is client_id, client_secret and id_token?

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.

For more information and questions, please refer to our blog page and the FAQ page. Or send an e-mail to YouCamOnlineEditor_API@perfectcorp.com. Our customer success team are very happy to help. ;)

Authentication with Perfect API server.

Query credit information and usage history.

AI Photo Enhance

AI Photo Enhancer uses advanced AI and deep learning to analyze image details and improve resolution, making low-resolution images clear & fix motion blur.

• No More Pixelation: Eliminate pixelation for smoother, more defined images.
• Fix Blurry Photos: Remove blurriness to reveal sharper, crisper details.
• Enhance Quality: Bring out finer details, making every part of your image stand out.
• Sharpen Images: Increase sharpness for clearer and more vivid images.
• Improve Clarity: Boost overall clarity to make your photos look fresh and professional.
• Face Enhancement: Refine facial features for more lifelike, enhanced portraits in motional images.

Before sample:

After sample:

Before sample:

After sample:

AI Object Removal

Remove unwanted objects with precision from your photos while preserving intricate details. To 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.

Sample input:

Sample output:

Sample input:

Sample output:

AI Photo Background Removal

Remove background from photo with impeccable accuracy, ensuring the high quality of images.

• Automatic Background Detection: : Uses AI to identify and separate the subject from the background.
• High Precision Editing: : Provides clean and precise edges around the subject.
• Supports various categories: People, Products, Animals, Cars, Graphics & more.
• Easy to chain with other AI tasks: The output file ID can be chained into other AI tasks in a flash.

Sample usage:

Sample uasge:

Sample input:

Sample output:

AI Photo Background Change

The 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.

By 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.

Sample Before:

After:

Before:

After: