跳到主要内容

SDK 概览

Aholo 提供三种语言的官方 SDK,封装了鉴权、分块上传、任务轮询等细节,让你无需手写 HTTP 即可快速接入。

能力矩阵​

能力TypeScriptJavaPython
通用上传(Asset)✅✅✅
世界(World)✅✅✅
Lux3D✅✅✅
渲染云(RenderCloud)———

渲染云暂无 SDK 封装,请直接参考 API Reference 中的渲染云接口文档。

版本说明: Lux3D SDK 当前最新为 v1.7.0(TypeScript / Java / Python),新增多模态生图,四视图支持文案,多格式导出增加 STL/3MF;生成版本为 G1 / G1-Turbo。World 为 v1.3.0;Asset、core 仍为 v1.2.0。MCP 为 @manycore/aholo-sdk-mcp@1.7.0。

快速安装​

# 按需安装,选你用到的包
npm install @manycore/aholo-sdk-asset
npm install @manycore/aholo-sdk-world
npm install @manycore/aholo-sdk-lux3d

包列表​

TypeScript / Node.js​

运行要求: Node.js ≥ 18

包名npm
@manycore/aholo-sdk-assetnpm
@manycore/aholo-sdk-worldnpm
@manycore/aholo-sdk-lux3dnpm
@manycore/aholo-sdk-corenpm

Java​

运行要求: Java 8+,Maven ≥ 3.6(从源码构建推荐使用 JDK 17 或 21)

ArtifactMaven Central
com.manycoreapis:aholo-sdk-asset查看
com.manycoreapis:aholo-sdk-world查看
com.manycoreapis:aholo-sdk-lux3d查看
com.manycoreapis:aholo-sdk-core查看

Python​

运行要求: Python ≥ 3.9

包名PyPI
manycore-aholo-sdk-assetPyPI
manycore-aholo-sdk-worldPyPI
manycore-aholo-sdk-lux3dPyPI
manycore-aholo-sdk-corePyPI

鉴权​

所有 SDK 均通过以下方式读取 API Key:

推荐: 环境变量(SDK 自动读取 AHOLO_API_KEY)

export AHOLO_API_KEY=your_api_key_here

也可在代码中显式传入,见各语言详细文档。

安全提示

请勿将 API Key 硬编码到源代码、安装包或公开仓库中。

API Key 申请:中国区 · 海外区

区域​

值说明API 接入点
cn中国区https://api.aholo3d.cn
com海外区https://api.aholo3d.com

异步任务与状态​

World 与 Lux3D 均为异步任务:创建后须轮询,直至进入终态。各语言 SDK 提供 waitFor / tasks.waitFor 封装轮询。

World 任务状态​

阶段状态值说明
进行中PENDING排队中
进行中PREPROCESSING预处理中
进行中RUNNING执行中
成功终态SUCCEEDED成功,可读取 assets.splats.urls(含 lodMetaPath)、assets.imagery.panoUrl(生成)、assets.semanticsMetadata.upAxis
失败终态FAILED失败
失败终态CANCELED已取消
失败终态TIMEOUT超时
失败终态REJECTED被拒绝

waitFor(worldId) 在 SUCCEEDED 时返回详情;遇到失败终态时抛出 PollingFailedError(Java 为 AholoException)。

Lux3D 任务状态​

值说明
0初始化
1进行中
3成功(outputs[n].content 为下载 URL,有效期约 2 小时)
4失败
6已取消

图生/文生 3D 支持 zip / glb / ply;材质迁移支持 zip / glb / usdz / obj zip / fbx zip;多格式导出支持 usdz / obj zip / fbx zip / stl / 3mf。

tasks.waitFor(taskId) 在 status === 3 时返回;status === 4 或 6 时抛出轮询失败错误。

详细文档​


GitHub README 仅作安装说明。若与本文冲突,以本文为准。源码与可运行示例见 GitHub。