API Overview

Integrate Aluo capabilities into your applications via REST API.

Introduction

Aluo API provides RESTful endpoints that allow you to integrate AI image processing capabilities into your own applications. All APIs use a credit-based billing system with different costs for Free and PRO users.

Base URL: https://api.aluo.ai/api

Authentication

All API requests require authentication via API Key in the HTTP header.

Authorization: Bearer sk-xxxxxxxxxxxxxx

How to get API Key: Login → User Settings → API Tab → Create New Key

Response Format

All API responses use a unified JSON format:

Success Response

{
  "code": 0,
  "success": true,
  "data": {
    // API specific data
  },
  "credits_deducted": 8,
  "credits_remaining": 42
}

Error Response

{
  "code": -1,
  "success": false,
  "message": "User-friendly error message",
  "error": "Detailed error description"
}

Error Codes

Code	Description	HTTP Status
`0`	Success	200
`-1`	Business error (invalid parameters, processing failed, etc.)	400/500
`-2`	Unauthorized or invalid API Key	401
`402`	Insufficient credits	402
`500`	Internal server error	500

Credits System

All API calls consume credits. PRO users enjoy lower credit costs.

Credits Deduction: For the Background Removal API (remove-bg), credits are automatically deducted when the API is called. For Image Generation and Editing APIs, credits are deducted by the client after obtaining the results. If processing fails, deducted credits will be automatically refunded to your account.

Available Endpoints

Rate Limits

Free tier: 10 requests/minute
PRO tier: 100 requests/minute
MAX tier: 1000 requests/minute