Catalog PyPI
PACKAGE EXPLORERView in registry

ailabtools-sdk

PyPI

Official async Python SDK for AILabTools AI image APIs: background removal, image upscaling, hairstyle changer, face retouching, object removal, and more.

aiailabtoolsapiasyncavatarbackgroundcartoonchangereditingfacehairstyleimageobjectphotoprocessingremoval
All keywords (21)
retouchsdktry-onupscalervirtual
Versions collected1
Direct dependencies1From release 0.5.4
Last observed21 Oct, 11:07 UTC

README

Version 0.5.4 documentation

AILabTools SDK - Async Python SDK for AI Image APIs

Official async Python SDK for AILabTools AI Image APIs.

Build AI-powered photo editing features with simple API calls: background removal, image upscaling, object removal, face retouching, hairstyle changer, age and gender swap, cartoon avatar generation, skin analysis, virtual try-on, and more.

Requirements

  • Python 3.8 or later

Installation

Install the Python SDK:

pip install ailabtools-sdk

Import it in Python:

from ailabtools import AILabClient

Note: The PyPI package name is ailabtools-sdk, while the Python import name is ailabtools.

Quick Start

1. Get your API key

Create or copy your API key from the AILabTools Developer Console.

export AILAB_API_KEY="your_api_key_here"

2. Remove an image background

import os
import asyncio
from ailabtools import AILabClient

async def main():
    client = AILabClient(api_key=os.environ["AILAB_API_KEY"])

    with open("./photo.jpg", "rb") as image:
        result = await client.background.remove({
            "image": image,
            "returnForm": "whiteBK",
        })

    print(result["data"]["image_url"])
    await client.aclose()

asyncio.run(main())

The SDK uses camelCase parameters and maps them automatically to API field names. For example, upscaleFactor maps to upscale-factor, and returnForm maps to return_form.

Popular APITypical use caseSDK methodTry online
Cartoon Yourself APICreate cartoon portraits and avatars from photos.client.portrait.portraitCartoonYourself()Try Cartoon Yourself online
Change Facial Expressions APIEdit smiles, grins, sadness, and other facial expressions.client.portrait.portraitExpressionEditing()Try Change Facial Expressions online
Hairstyle Changer Premium APIPreview preset hairstyles or transfer a hairstyle from a reference image.client.portrait.portraitHairstyleEditingPremium()Try Hairstyle Changer online
Try on Clothes Premium APIGenerate high-quality virtual clothing try-on results.client.portrait.portraitTryOnClothesPremium()Try Virtual Clothes Try-On online
Skin Analyze Pro APIAnalyze skin condition, texture, tone, acne, pores, and wrinkles.client.portrait.portraitSkinAnalysisProfessional()Try AI Skin Analyzer online
Face Beauty Pro APIApply advanced portrait beautification and face shaping.client.portrait.portraitFacialBeautificationPro()Try Retouch Portraits online
AI Face Swap APISwap a face into a target portrait while preserving the scene.client.portrait.portraitAIFaceSwap()Try AI Face Swap online
AI Breast Expansion APIApply a controlled bust-area adjustment to a portrait.client.portrait.portraitAIBreastExpansion()Try AI Breast Expansion online

Browse more demos in AILabTools AI Portrait Tools and AILabTools AI Image Tools.

View the complete AILabTools SDK API index.

Common Developer-Friendly Aliases

Both full API method names and short aliases are supported. For example, client.background.remove() calls the same Universal Background Removal API as client.cutout.cutoutUniversalBackgroundRemoval().

APIFull methodAlias
Universal Background Removalclient.cutout.cutoutUniversalBackgroundRemoval()client.background.remove()
Image Upscalerclient.image.imageLosslessEnlargement()client.image.upscale()
Remove Objectsclient.image.imageRemoveObjects()client.image.remove_objects()
Hairstyle Changer Proclient.portrait.portraitHairstyleEditingPro()client.portrait.change_hairstyle()
Smart Beautyclient.portrait.portraitIntelligentBeautification()client.portrait.retouch()

View the complete method and alias reference.

File Uploads

File parameters support file-like objects with a read method, or bytes / bytearray.

Async Task Example

Some APIs return task_id for long-running image generation or enhancement jobs. Use wait_for_task to poll until the task succeeds, fails, or times out.

task = await client.portrait.change_hairstyle({
    "taskType": "async",
    "image": image,
    "hairStyle": "BuzzCut",
    "color": "blonde",
})

task_id = task.get("task_id") or task.get("data", {}).get("task_id")
result = await client.wait_for_task(
    task_id,
    interval=5,
    timeout=300,
    raise_on_failed=True,
)

print(result.get("data"))

API Reference

Error Handling

API errors raise AILabApiError, which includes troubleshooting fields such as request_id and log_id.

try:
    with open("./photo.jpg", "rb") as image:
        result = await client.background.remove({
            "image": image,
            "returnForm": "whiteBK",
        })
    print(result["data"]["image_url"])
except Exception as error:
    print("AILabTools API Error:", error)
    # Send request_id and log_id to support if you need help.

Testing

AILAB_API_KEY=xxx pytest -q

License

MIT

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Versions 1

Collected releases
VersionPublishedDirect dependenciesOpen version
0.5.428 Jun 20261

Package advisories

0
No matching advisories collected

This describes our collected data; it is not a security assessment.

Repository

PENDING
ailabtools/ailabtools-sdk

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 21 Oct, 11:07 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package:232d3c93d929f9412d0598c24b4524e8356edd181f90e40f6cb74e2c4080960a