AI Beard Style Generator

Integration Guide

1. Upload a Selfie You can provide the source image in one of two ways:

• Use an Existing Public Image URL Instead of uploading, you may supply a publicly accessible image URL directly when initiating the AI task.

• Upload via File API Use the endpoint:

  POST /s2s/v2.0/file

  This returns a file_id for subsequent task execution.

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

    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.

2. List Predefined Styles

   • Use /s2s/v2.0/task/template/beard-style to fetch a predefined template list and select a template_id to run an AI task.

3. Run an AI Task to Obtain a Task ID Execute the AI task using /s2s/v2.0/task/beard-style. For the target user image, provide either src_file_url or src_file_id. And a stype template_id to apply and obtain a task_id.

4. Poll to Check the Status of a Task Until It Succeeds or Fails Use the task_id to monitor the task status by polling GET /s2s/v2.0/task/beard-style to retrieve the current engine status. Until the engine completes the task, the status will remain as running, and no units will be consumed during this stage. You can also implement a webhook to receive notifications when an AI task succeeds or fails. Refer to the Webhook section for details.

   Warning: Polling to check the status of a task within its retention period is mandatory. A task will time out if there is no polling request within the retention period, even if the task is processed successfully. Your units will still be consumed.

   Warning: You will receive an InvalidTaskId error if you check the status of a timed-out task. Therefore, once you run an AI task, you must poll to check the status within the retention period until the status becomes either success or error.

5. Retrieve the Result of an AI Task Once Successful The task status will change to success after the engine processes your input file and generates the resulting image. You will receive a URL for the processed image.

File Specs & Errors

• Supported Formats & Dimensions

• Error Codes

• Environment & Dependency