API文档
API概览
简介
Aluo AI API提供强大的图像处理能力,包括智能背景移除、AI图像生成和编辑等功能。非常适合电商产品摄影、营销素材设计、内容创作等场景。所有API均基于REST架构,支持JSON数据交换。
基础URL
所有API请求的基础URL:https://aluo.ai/api
身份认证
API支持两种认证方式:
1. API密钥认证(推荐):在请求头中包含 Authorization: Bearer YOUR_API_KEY
- API密钥以 "sk-" 开头
- 可在Aluo AI控制台的"API密钥"页面获取
2. 会话认证:适用于已登录的Web应用
- 通过Cookie传递会话信息
- 需要用户已登录Aluo AI平台
积分系统
所有业务API均消耗积分,不同用户类型享有不同的积分价格:
- 免费用户:标准积分定价
- 订阅用户(创作者+专业版):享受积分优惠
API密钥管理
获取API密钥
在Aluo AI控制台中创建和管理您的API密钥。
操作步骤:
- 登录Aluo AI平台:https://aluo.ai
- 进入控制台页面
- 点击左侧菜单中的"API密钥"
- 点击"创建新密钥"按钮
- 为密钥设置名称和权限
- 复制生成的密钥(以sk-开头)
重要提示
- 请妥善保管您的API密钥,不要在代码中硬编码
- 建议使用环境变量存储API密钥
- 可以随时在控制台中禁用或删除不需要的密钥
密钥安全
保护您的API密钥安全的最佳实践。
操作步骤:
- 将API密钥存储在环境变量中,而不是代码中
- 定期轮换API密钥
- 监控API密钥的使用情况
- 如发现泄露,立即在控制台中禁用
智能背景移除
POST /api/remove-bg
使用先进的BRIA AI模型智能移除图像背景,支持发丝级细节保留。返回JSON格式,包含处理后图片的URL和详细信息。完美适用于产品图处理、人像抠图等场景。
💳 积分消耗
请求参数
使用 multipart/form-data 格式上传图像文件。
操作步骤:
- file (必填): 图像文件,支持 PNG、JPG、WebP 格式
- 最大文件大小:10MB
- 推荐分辨率:不超过 4096x4096 像素
响应格式
返回JSON格式,包含处理后的图片URL、文件信息和尺寸数据:
• url: 处理后图片的CDN地址(PNG格式,透明背景)
• originalFileName: 原始文件名
• processedFileName: 处理后文件名
• width/height: 图片尺寸
• fileSize: 文件大小(字节)
• contentType: 内容类型(image/png)
使用场景
• 电商产品图:快速移除产品照片背景,制作白底图
• 人像处理:发丝级精度移除人像背景,便于后期合成
• 素材制作:为设计素材去除背景,提高重用性
• 证件照处理:快速制作标准证件照背景
AI智能图像编辑
POST /api/photo-editor/generate
基于参考图像和文本提示,使用最新的Fal AI Nano-Banana模型对图像进行智能编辑。支持多张参考图(最多5张),可实现风格转换、内容调整、质量增强等效果。这是异步任务,任务创建后返回taskId,需轮询status接口获取结果。
💳 积分消耗
请求方式
支持两种请求方式:
1. JSON方式(推荐)
Content-Type: application/json
适用于已上传的图片,直接传递图片URL数组
2. FormData方式
Content-Type: multipart/form-data
适用于直接上传本地文件,支持file0, file1, file2...多文件上传
请求参数(JSON方式)
操作步骤:
- prompt (必填): 编辑指令的自然语言描述
- imageUrls (必填): 参考图片URL数组,1-5张
- aspectRatio (可选): 输出宽高比(16:9、1:1、9:16、4:3、3:4等)
- outputFormat (可选): 输出格式,默认png(jpeg、png、webp)
- numImages (可选): 生成图片数量,默认1
请求参数(FormData方式)
操作步骤:
- prompt (必填): 编辑指令文本
- file0, file1, file2... (必填): 图片文件,1-5个
- aspectRatio (可选): 输出宽高比
- outputFormat (可选): 输出格式,默认png
- numImages (可选): 生成图片数量,默认1
响应格式
成功返回JSON,包含taskId和输入信息:
• taskId: 任务ID,用于查询结果
• provider: AI提供商(fal)
• prompt: 使用的提示词
• inputImages: 输入图片URL数组
• aspectRatio: 宽高比设置
• outputFormat: 输出格式
GET /api/photo-editor/status?taskId=xxx
查询AI图像编辑任务状态和结果。
查询参数:
• taskId (必填): 从generate接口获取的任务ID
响应格式:
• status: 任务状态(SUCCESS/PENDING/FAILED)
• images: 编辑后的图片数组(包含url、width、height等信息)
• description: 图片描述(如果有)
使用场景
• 产品图优化:基于多张参考图改善产品照片效果
• 风格转换:将普通照片转换为特定艺术风格
• 内容增强:提升图像质量、添加或修改视觉元素
• 创意设计:多图融合进行创意性的视觉改造
AI产品图生成
POST /api/photo-generate/generate
使用最新的Fal AI Nano-Banana模型,根据文本描述生成高质量的产品图像。相比之前提升约3倍速度,支持多种尺寸、格式和批量生成。这是异步任务,任务创建后返回taskId,需轮询status接口获取结果。
💳 积分消耗
请求参数
操作步骤:
- prompt (必填): 产品描述的自然语言文本
- size (可选): 图像宽高比,默认1:1(支持:1:1、3:2、2:3、16:9、9:16、4:3、3:4、4:5、5:4、21:9)
- outputFormat (可选): 输出格式,默认png(jpeg、png、webp)
- nVariants (可选): 生成变体数量,默认1(支持1、2、4)
响应格式
成功返回JSON,包含taskId和生成配置:
• taskId: 任务ID,用于查询结果
• provider: AI提供商(fal)
• prompt: 使用的提示词
• size: 宽高比设置
• outputFormat: 输出格式
• nVariants: 变体数量
GET /api/photo-generate/status?taskId=xxx
查询AI产品图生成任务状态和结果。
查询参数:
• taskId (必填): 从generate接口获取的任务ID
响应格式:
• status: 任务状态(SUCCESS/PENDING/FAILED)
• images: 生成的图片数组(包含url、width、height、content_type等)
• timings: 性能指标(推理时间等)
使用场景
• 电商产品图:为新产品快速生成专业产品图
• 营销素材:批量制作产品宣传和广告素材
• 概念设计:可视化产品创意和设计方案
• A/B测试:生成多个变体进行效果对比
• 样品展示:在实物制作前预览产品效果
AI背景图生成
POST /api/ai-generate-background
基于文本描述即时生成专业背景图像,适用于产品摄影、场景设计等用途。支持多种风格和环境设置,可快速为产品或内容创建合适的背景环境。这是同步接口,直接返回生成结果。
💳 积分消耗
请求参数
prompt (必填): 背景描述文本,支持中英文
可描述风格、颜色、材质、光照等要素
支持场景描述:如"摄影棚"、"自然环境"、"室内场景"等
使用场景
• 产品摄影:为产品生成专业拍摄背景
• 电商设计:创建产品展示的环境氛围
• 内容创作:为文章、海报制作合适背景
• 品牌视觉:统一品牌的视觉背景风格
响应格式
同步返回生成结果,包含背景图像URL。