> For the complete documentation index, see [llms.txt](https://cityweft.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cityweft.gitbook.io/docs/readme.md).

# Welcome

Welcome to the **Cityweft API** — your gateway to high-quality, context-rich **3D city models**, **terrain data**, and **infrastructure information** across the globe.

Cityweft provides developers, designers, and AEC professionals with seamless access to:

* ⚙️ Accurate 3D urban models
* 🏗️ Infrastructure data
* 🗺️ Geo-referenced terrain meshes
* 🚦 Smart metadata for early-stage planning

Our API is designed to integrate effortlessly with your platform, enabling dynamic urban context loading, site analysis, and location-specific decision-making — all with just a few lines of code.

Whether you're building a digital twin, urban planning tool, or a generative design platform, **Cityweft** helps you start every project with the right data in a flexible format.

### Jump right in

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Getting Started</strong></td><td>Basic Overview on How to Access and Work With Cityweft's Output</td><td><a href="https://2449447963-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2ahel6HN9zgEzJ1vY9kr%2Fuploads%2FV6iJW1DMvvgrBmXhkTDS%2F1746439206345.jpeg?alt=media&amp;token=db8838ce-a40e-40c0-9f9c-050f5a0475c5">1746439206345.jpeg</a></td><td></td><td><a href="/docs/getting-started/quickstart.md">Quickstart</a></td></tr><tr><td><strong>API Reference</strong></td><td>Explore Every Parameter and Test Requests With Your Own API Key</td><td><a href="https://2449447963-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2ahel6HN9zgEzJ1vY9kr%2Fuploads%2FoTL7xRa8vHAI6kw2VRsI%2FScreenshot%202025-07-25%20at%2013.23.14.png?alt=media&amp;token=dc281311-9721-456d-9349-ffeb312e6cde">Screenshot 2025-07-25 at 13.23.14.png</a></td><td></td><td><a href="/docs/getting-started/api-reference.md">API Reference</a></td></tr><tr><td><strong>Three.js Guide</strong></td><td>Learn How To Quickly Integrate the Urban Context to Your Three.js Scene</td><td><a href="https://2449447963-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2ahel6HN9zgEzJ1vY9kr%2Fuploads%2FyBJsYmG9WByrPmXYLRaB%2Fscene-1746743413218.png?alt=media&amp;token=bbb62b6d-4839-40fa-8762-f0bcdb12b0da">scene-1746743413218.png</a></td><td></td><td><a href="/docs/getting-started/three-quick-guide.md">Three.js Quick Guide</a></td></tr><tr><td><strong>Customizations</strong></td><td>Explore Advanced API Settings Designed to Customize Your Output</td><td><a href="https://2449447963-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2ahel6HN9zgEzJ1vY9kr%2Fuploads%2FX3hbLnQ5HNltP5IAvbFW%2FScreenshot%202025-06-06%20at%2001.45.19.png?alt=media&amp;token=4eb2919d-25ef-4d1c-9ea2-5ac3be157c72">Screenshot 2025-06-06 at 01.45.19.png</a></td><td></td><td><a href="/docs/basics/customizations.md">Customizations</a></td></tr></tbody></table>

### Geometry Types

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th><select multiple><option value="GXJDE1CloO2K" label="Meshes" color="blue"></option><option value="P8roCyk5SLOJ" label="Nodes" color="blue"></option><option value="00g40lPSezeL" label="ElevationMaps" color="blue"></option><option value="PolyLn123456" label="Polylines" color="blue"></option></select></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="image">Cover image</th><th data-hidden></th></tr></thead><tbody><tr><td><strong>Buildings</strong></td><td>Buildings Geometry</td><td><span data-option="GXJDE1CloO2K">Meshes</span></td><td><a href="/docs/geometry/buildings.md">Buildings</a></td><td><a href="https://2449447963-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2ahel6HN9zgEzJ1vY9kr%2Fuploads%2FED6oIRABg7A5kmFBPiDx%2Fthumbnail%20(1).png?alt=media&amp;token=28d8bc11-444c-4815-ad2c-9664e728b42f">thumbnail (1).png</a></td><td></td></tr><tr><td><strong>Surface</strong></td><td>Surface Geometry</td><td><span data-option="GXJDE1CloO2K">Meshes</span></td><td><a href="/docs/geometry/surface.md">Surface</a></td><td><a href="https://2449447963-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2ahel6HN9zgEzJ1vY9kr%2Fuploads%2F1O5eVQfaMEe4m5xTKwkW%2FScreenshot%202026-08-28%20at%2011.52.57.png?alt=media&amp;token=d0330afc-9ce4-48f9-90cb-b2174d41d4f4">Screenshot 2026-08-28 at 11.52.57.png</a></td><td></td></tr><tr><td><strong>Surface Lines</strong></td><td>Centerlines &#x26; Outlines</td><td><span data-option="PolyLn123456">Polylines</span></td><td><a href="/docs/geometry/surface-lines.md">Surface Lines</a></td><td><a href="https://2449447963-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2ahel6HN9zgEzJ1vY9kr%2Fuploads%2FZPwTZuFAxwcxiOiBY2HW%2FScreenshot%202026-08-28%20at%2000.30.29.png?alt=media&amp;token=259c9ec5-66ac-4c08-a47f-188aa1d9946b">Screenshot 2026-08-28 at 00.30.29.png</a></td><td></td></tr><tr><td><strong>Barriers</strong></td><td>Walls &#x26; Fences Geometry</td><td><span data-option="GXJDE1CloO2K">Meshes</span></td><td><a href="/docs/geometry/barriers.md">Barriers</a></td><td><a href="https://2449447963-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2ahel6HN9zgEzJ1vY9kr%2Fuploads%2Fc9EZsiHGfKMiXQIY83UE%2Fscene-1749156254236.png?alt=media&amp;token=6a7ba616-b45d-4094-8baa-a538bcbd8436">scene-1749156254236.png</a></td><td></td></tr><tr><td><strong>Infrastructure</strong></td><td>Point Instances</td><td><span data-option="P8roCyk5SLOJ">Nodes</span></td><td><a href="/docs/geometry/infrastructure.md">Infrastructure</a></td><td><a href="https://2449447963-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2ahel6HN9zgEzJ1vY9kr%2Fuploads%2Fk1NAhPG61naImwNJ5GJ4%2FScreenshot%202026-07-06%20at%2010.52.19.png?alt=media&amp;token=ff414549-4e2b-4f2b-b001-b2ee88d80f9f">Screenshot 2026-07-06 at 10.52.19.png</a></td><td></td></tr><tr><td><strong>Topography</strong></td><td>Topography geometry</td><td><span data-option="00g40lPSezeL">ElevationMaps, </span><span data-option="GXJDE1CloO2K">Meshes</span></td><td><a href="/docs/geometry/topography.md">Topography</a></td><td><a href="https://2449447963-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2ahel6HN9zgEzJ1vY9kr%2Fuploads%2F08PUIEcMuj5jtD73TJ7e%2Fimage%20(1).webp?alt=media&amp;token=386c2f7e-88a4-404e-9dbb-3bc33f7eb386">image (1).webp</a></td><td></td></tr></tbody></table>