Worlds
World generation endpoints
Create a new world generation job
Create a new world generation job
List API jobs on this account
Returns worlds generated through the API by any key on your account. Worlds created in the Spaitial web app (dashboard) are not included, even for the same account. Generate through the API if you need the pipeline to list the result. `status` is optional; omitting it returns the same unfiltered page as before.
Get job status
Progress is 0..1 when the pipeline has meaningful stage movement, otherwise null (never treat null as 0%). Long reconstruction jobs return the current model alias estimated_duration_seconds so clients can show ETA + elapsed instead of a percent. world_id is set as soon as the world is created, before the job completes.
Get full job result
Get full job result
Update world visibility or title
Update world visibility or title
Cancel a job
Cancel a job
Start or retrieve an export for a completed job
Export artifacts from worlds: collision meshes (mesh, mesh-simplified), a top-down floorplan render (floorplan), and a zip bundle of world assets (zip). Zip exports accept an optional JSON body {'include': ['spz', 'sog', 'ply', 'mesh', 'floorplan']} and default to all assets. Exports can take several minutes, so check the status before requesting the download URL.
Get export status
Returns export status. When ready, the response includes a backend proxy download_url. Add ?download=1 to this same endpoint to redirect to a short-lived signed file URL. Zip exports accept ?include=spz,sog,... (comma-separated) to address the zip for that asset set; omit it for the default all-assets zip.
List exports for a completed job
List exports for a completed job
Download the splat artifact for a completed job
Redirects (302) to a short-lived signed download URL. The URL is valid for ~5 minutes; re-hit this endpoint when it expires.
Download the panorama artifact for a completed job
Redirects (302) to a short-lived signed download URL. The URL is valid for ~5 minutes; re-hit this endpoint when it expires.