API Documentation

Aluo AI API provides powerful image processing capabilities including intelligent background removal, AI image generation and editing. Perfect for e-commerce product photography, marketing material design, content creation and more. All APIs are REST-based and support JSON data exchange.

Base URL for all API requests: https://aluo.ai/api

API supports two authentication methods:

1. API Key Authentication (Recommended): Include Authorization: Bearer YOUR_API_KEY in request headers

- API Key starts with "sk-"

- Get from "API Keys" page in Aluo AI console

2. Session Authentication: For logged-in web applications

- Pass session info via Cookie

- Requires user logged into Aluo AI platform

All business APIs consume credits. Different user types have different credit costs:

- Free users: Standard credit pricing

- Subscribed users (Creator + Pro): Enjoy credit discounts

Create and manage your API keys in the Aluo AI console.

Best practices for protecting your API key security.

Use advanced BRIA AI model to intelligently remove photo backgrounds, supporting hair-level detail preservation. Returns JSON format including processed image URL and detailed information. Perfect for product image processing, portrait cutouts and more.

Upload image files using multipart/form-data format.

Returns JSON format with processed image URL, file info and dimension data:

• url: CDN URL of processed image (PNG format, transparent background)

• originalFileName: Original filename

• processedFileName: Processed filename

• width/height: Image dimensions

• fileSize: File size (bytes)

• contentType: Content type (image/png)

• E-commerce products: Quickly remove product photo backgrounds, create white background images

• Portrait processing: Hair-level precision removal of portrait backgrounds for easy composition

• Material creation: Remove backgrounds from design materials for better reusability

• ID photo processing: Quickly create standard ID photo backgrounds

Based on reference images and text prompts, use the latest Fal AI Nano-Banana model for intelligent image editing. Supports multiple reference images (up to 5), achieving style conversion, content adjustment, quality enhancement and more. This is an async task that returns taskId after creation, requiring polling of the status endpoint for results.

Supports two request methods:

1. JSON Method (Recommended)

Content-Type: application/json

For already uploaded images, directly pass image URL array

2. FormData Method

Content-Type: multipart/form-data

For direct local file upload, supports file0, file1, file2... multi-file upload

Returns JSON with taskId and input information:

• taskId: Task ID for querying results

• provider: AI provider (fal)

• prompt: Used prompt

• inputImages: Input image URL array

• aspectRatio: Aspect ratio setting

• outputFormat: Output format

Query AI image editing task status and results.

Query Parameters:

• taskId (required): Task ID obtained from generate endpoint

Response Format:

• status: Task status (SUCCESS/PENDING/FAILED)

• images: Array of edited images (including url, width, height, etc.)

• description: Image description (if available)

• Product optimization: Improve product photo effects based on multiple reference images

• Style conversion: Convert ordinary photos to specific artistic styles

• Content enhancement: Improve image quality, add or modify visual elements

• Creative design: Multi-image fusion for creative visual transformation

Use the latest Fal AI Nano-Banana model to generate high-quality product images based on text descriptions. Approximately 3x faster than before, supporting multiple sizes, formats and batch generation. This is an async task that returns taskId after creation, requiring polling of the status endpoint for results.

Returns JSON with taskId and generation config:

• taskId: Task ID for querying results

• provider: AI provider (fal)

• prompt: Used prompt

• size: Aspect ratio setting

• outputFormat: Output format

• nVariants: Number of variants

Query AI product image generation task status and results.

Query Parameters:

• taskId (required): Task ID obtained from generate endpoint

Response Format:

• status: Task status (SUCCESS/PENDING/FAILED)

• images: Array of generated images (including url, width, height, content_type, etc.)

• timings: Performance metrics (inference time, etc.)

• E-commerce products: Quickly generate professional product images for new products

• Marketing materials: Batch create product promotion and advertising materials

• Concept design: Visualize product ideas and design proposals

• A/B testing: Generate multiple variants for effect comparison

• Sample display: Preview product effects before physical production

Instantly generate professional background images based on text descriptions, suitable for product photography, scene design and more. Supports various styles and environmental settings, can quickly create appropriate background environments for products or content. This is a synchronous API that returns results immediately.

prompt (required): Background description text, supports Chinese and English

Can describe style, color, material, lighting and other elements

Supports scene descriptions like "studio", "natural environment", "indoor scene", etc.

• Product photography: Generate professional shooting backgrounds for products

• E-commerce design: Create environmental atmosphere for product display

• Content creation: Make suitable backgrounds for articles and posters

• Brand visual: Unify brand visual background style

Synchronously returns generation results, including background image URL.