Palatial API

Code reference: checked on October 6, 2026 against Backend dev commit 0341915. This is a source-contract check; use the API host provided for your integration.

Use the Palatial API to create SimReady 3D assets from text, photos, video, or CAD files, track generation progress, and download results programmatically.

All routes below use your API key and live under:

<https://dashboard.palatial.cloud/api/v1/external/>

Contact Palatial if you need a sandbox or staging environment for integration testing.

Getting started

1. Create an API key in the Palatial dashboard (workspace settings). Keys are scoped to your workspace.
2. Send the key on every request using one of:
   • Header: x-api-key: YOUR_API_KEY
   • Header: Authorization: Bearer YOUR_API_KEY
3. Create an asset with Image → Sim (photos/video), Text → Sim, or CAD → Sim. For Text/Image, choose a mode and put its build settings in parameters.
4. Poll status until the asset is READY. Handle failure, cancellation, or a billing pause; research-backed jobs may also need a caller answer or selection.
5. Download the SimReady export ZIP or individual outputs (mesh, texture, collisions, etc.).

Batch asset creation (Dev)

POST https://dashboard.dev.palatial.cloud/api/v1/external/assets/batch

One request starts 1–10 independent Text, Image, or CAD generations. Convert table rows into an items array; CSV, Excel, and Notion documents are not accepted directly.

• Each item has a unique id (1–40 letters, numbers, _, or -), a type (text, image, or cad), and an input object using the corresponding single-create contract.
• Text and Image rows use input.mode, input.effort, and input.parameters as described under Generation. CAD uses its existing flat fields.
• Batch Image rows accept one <row-id>.file or 2–4 named views (front, left, back, right), with no mixing or repeated file field, even when the corresponding single-create route accepts more photos. CAD uses <row-id>.mesh and optional <row-id>.image / <row-id>.datasheet. Mad Max Text/Image rows may attach one <row-id>.reference_mesh.