ailabtools-sdk 0.5.3

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

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.

• Install from PyPI: pip install ailabtools-sdk
• Import in Python: from ailabtools import AILabClient
• 60+ active AI image, cutout, and portrait APIs
• Supports file uploads, URL input, async tasks, and temporary result URLs
• Get started with the AILabTools Developer Console

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 Use Cases

Use case	API	SDK method
Remove image background	Universal Background Removal	client.background.remove()
Upscale image 2x / 4x	Image Upscaler	client.image.upscale()
Change hairstyle	Hairstyle Changer Pro	client.portrait.change_hairstyle()
Retouch portrait	Smart Beauty	client.portrait.retouch()
Remove objects	Remove Objects	client.image.remove_objects()
Generate cartoon avatar	Cartoon Yourself	client.portrait.portraitCartoonYourself()
Analyze face attributes	Face Analyzer	client.portrait.portraitFaceAnalyzer()
Virtual try-on	Try on Clothes Pro	client.portrait.portraitTryOnClothesPro()

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().

API	Full method	Alias
Universal Background Removal	client.cutout.cutoutUniversalBackgroundRemoval()	client.background.remove()
Image Upscaler	client.image.imageLosslessEnlargement()	client.image.upscale()
Remove Objects	client.image.imageRemoveObjects()	client.image.remove_objects()
Hairstyle Changer Pro	client.portrait.portraitHairstyleEditingPro()	client.portrait.change_hairstyle()
Smart Beauty	client.portrait.portraitIntelligentBeautification()	client.portrait.retouch()

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({
    "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

• AILabTools API Documentation
• Get your AILabTools API key
• AILabTools SDK Documentation
• Node.js SDK on npm
• AILabTools SDK on GitHub
• SDK examples

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