AHOLO Open API
欢迎使用 Aholo 开放平台 API 文档。你可以在这里查阅接口说明、完成首次调用,并为 AI 助手配置相关 Skills。
生产网关:https://api.aholo3d.cn(各接口完整路径以 API 中的 Servers 与路径为准)。
能做什么
本站当前覆盖四类主要能力:
资产上传(Asset)
上传图片或视频到对象存储, 供后续世界任务等接口使用:
- 调用
GET /asset/v1/token获取 OUS 上传凭证; - 在响应中的
globalDomain(国内常见为https://ous-cos.kujiale.com,以接口实际返回为准)上完成直传或分片上传; - 将得到的可访问 URL 填入创建世界等业务的请求体。
上传步骤详见 API 侧栏 资产 服务下的 Asset 标签;/ous/api/... 路径在 COS 域名上调用,不加网关前缀。
世界(World)
面向 3D 高斯溅射(3DGS) 的异步任务:
| 能力 | 说明 |
|---|---|
| 世界重建 | 多图(≥20 张)、普通视频或 Insta360 全景(.insv)生成 3D 世界;扩展名须与 OpenAPI 中 type 一致 |
| 世界生成 | 用文字、单张图或图文组合生成 3D 世界。室内效果更好;非室内仍可尝试,但目前为 Beta,质量预期可能明显弱于室内(详见 OpenAPI 该接口说明) |
典型流程:上传素材 → 创建任务 → 用返回的 worldId 轮询状态 → 任务成功后获取模型下载地址(如 PLY / SPZ)。
世界类接口路径前缀为 /world/v1(例如 POST /world/v1/reconstructions、GET /world/v1/{worldId})。
渲染云(RenderCloud)
提供 OpenUSD 离线渲染 等能力(如 POST /rendercloud/v1/jobs)。鉴权方式以各接口在规范中的说明为准。
Lux3D
3D 生成服务,侧重高质量 PBR 材质,与 3DGS 世界能力互补:
| 能力 | 说明 |
|---|---|
| 图生 3D | 输入图片生成 3D 模型 |
| 文生 3D | 输入文案(可带参考图)生成 3D 模型 |
| 材质重绘 | 对已有模型进行材质重绘 |
典型流程:创建异步任务 → 用返回的 taskId 轮询状态 → 成功后下载结果。默认 v3.0-standard,输出 zip / glb 及可选 usdz、obj、fbx 格式(见 API)。
接口路径前缀为 /lux3d/v1(例如 POST /lux3d/v1/generate/img-to-3d/task/create)。详见 API 侧栏 Lux3D,或 Lux3D Skill。
文档怎么读
| 章节 | 适合什么时候看 |
|---|---|
| 快速开始 | 已有 API key,想尽快跑通一次重建或生成 |
| 授权 | 了解 Authorization 请求头与 OUS 上传凭证的区别 |
| API | 查字段、枚举、请求示例与错误结构(侧栏按 资产 → 世界 → 渲染云 → Lux3D 分组;以 OpenAPI 为准) |
| 发行说明 | 查看 API、SDK 与文档的发布记录 |
| Skills | 在 Cursor 等助手中安装自动化调用技能 |
| MCP | 在 Cursor / Claude Desktop 中配置 Aholo MCP Server |
调用前须知
- 鉴权:除 OUS 上传外,开放平台接口均在请求头携带
Authorization: <API key>(无需Bearer前缀)。API key 在 labs.aholo3d.cn/api-keys 申请。 - 异步任务:创建成功返回
WorldAsyncOperation,其中的worldId用于后续查询;请轮询详情接口直至SUCCEEDED、FAILED等终态。 - 时间字段:世界详情与列表中的
createTime/updateTime为 Unix 毫秒时间戳。