AHOLO Open API

Welcome to the Aholo Open Platform API documentation. Use this site to explore endpoints, make your first calls, and set up Skills for AI assistants.

Production gateway: https://api.aholo3d.com. Gateway routes use the /global prefix (e.g. /global/asset/v1/token, /global/world/v1/reconstructions). Full paths are in the API under Servers and each operation.

What you can build

Asset upload

Upload images or video to object storage for downstream APIs (such as world jobs):

1. Call GET /global/asset/v1/token for OUS upload credentials;
2. Upload on the returned globalDomain (international region often https://ous-sg.kujiale.com; see the actual token response);
3. Put the public URLs into your create-world (or other) request body.

See the Asset tag under the Asset service in the API sidebar. Paths under /ous/api are called on globalDomain and are not prefixed with /global.

World

Async jobs for 3D Gaussian Splatting (3DGS):

Capability	Description
Reconstruction	Build a 3D world from many images or from video
Generation	Text, one image, or both. Indoor scenes look best today; non-indoor is supported but still beta and may trail indoor quality materially (see the generation operation in OpenAPI).

Typical flow: upload assets → create a job → poll with worldId → download outputs (e.g. PLY / SPZ) when the job succeeds.

Example paths: POST /global/world/v1/reconstructions, GET /global/world/v1/{worldId}.

RenderCloud

OpenUSD offline rendering (e.g. POST /global/rendercloud/v1/jobs). Auth headers are defined per operation in the spec.

Lux3D

3D generation with a focus on high-quality PBR materials, complementary to 3DGS world APIs:

Capability	Description
Image to 3D	Generate a 3D model from an input image
Text to 3D	Generate from a prompt (optional reference image)
Material transfer	Repaint materials on an existing model

Typical flow: create an async task → poll with the returned taskId → download results (e.g. GLB, PBR textures) when done.

Example paths: POST /global/lux3d/v1/generate/img-to-3d/task/create. See Lux3D in the API sidebar, or the Lux3D Skill.

How this site is organized

Section	When to use it
Quick Start	You have an API key and want a first successful call
Authentication	Gateway Authorization vs OUS upload tokens
API	Fields, enums, examples, and errors (sidebar: Asset → World → Render Cloud → Lux3D; OpenAPI is authoritative)
Skills	Install Agent Skills for Cursor and similar tools

Before you call the API

1. Auth: Set Authorization: <API key> on gateway calls (no Bearer prefix). Get keys at labs.aholo3d.com/api-keys.
2. Async jobs: Create returns WorldAsyncOperation with worldId; poll details until a terminal status such as SUCCEEDED or FAILED.
3. Timestamps: createTime / updateTime in world responses are Unix milliseconds.

Start with Quick Start, then use the API as needed.