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:
  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.).

Authentication & access

Key type What you can access
Workspace API key (recommended) Assets and workspaces tied to that workspace
User-scoped key Assets you own in your workspaces
Master key (enterprise) Broader access; some calls require an explicit owner field

If you receive 403 Forbidden, check that the asset belongs to the workspace attached to your API key and that your workspace has sufficient export credits.

HTTP status codes

Code Meaning
200 Success
201 Resource created
307 Redirect (export download — follow with -L in cURL)
400 Invalid request (check field names and values)
403 Invalid API key or insufficient permissions/credits
404 Asset or workspace not found
500 Server error — retry with backoff