Palatial API

Use the Palatial API to create SimReady 3D assets from images, text, 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
   • Query: ?api_key=YOUR_API_KEY
3. Create an asset with one of the generation endpoints (Image → Sim, Text → Sim, or CAD → Sim).
4. Poll status until the asset is READY (or handle PROCESSING_FAILED).
5. Download the SimReady export ZIP or individual outputs (mesh, texture, collisions, etc.).

Feature highlights

• Generated texture size: use texture_size=2048, 4096, or 8192 for 2K, 4K, or 8K provider-generated textures. The default is 4096 (4K).
• Texture delivery optimization: optimize_textures=true downsizes maps above texture_max_resolution. For Meshy outputs, eligible opaque base-color maps may be delivered as high-quality JPEG sidecars while technical maps remain lossless. It never upscales smaller maps.
• Image-generated decimation compatibility: omitting decimation controls preserves the legacy adaptive reduction path. Pass decimation=false to explicitly disable it. New integrations may use decimation_mode=auto, or decimation_mode=strict with exactly one of decimation_target_faces or decimation_target_ratio. CAD omission remains disabled.
• Asset Variants: branch a successful asset into a new independent asset by describing the desired change in feedback. Palatial chooses the rebuild work. Do not send a pipeline stage.
• Reprocess vs Variant: POST /assets/{id}/reprocess overwrites the same asset. Sending destination: "variant" returns 400. Create a new asset with POST /assets/{id}/variants.
• CAD reference image: optional. Omit image to skip texture generation.