# 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.

{% hint style="info" %}
The API is under active development. While we aim to avoid breaking changes in existing versions, some parameters may still change.
{% endhint %}

### Jump right in

<table 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&#x26;token=db8838ce-a40e-40c0-9f9c-050f5a0475c5">1746439206345.jpeg</a></td><td></td><td><a href="getting-started/quickstart">quickstart</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&#x26;token=bbb62b6d-4839-40fa-8762-f0bcdb12b0da">scene-1746743413218.png</a></td><td></td><td><a href="getting-started/three-quick-guide">three-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&#x26;token=4eb2919d-25ef-4d1c-9ea2-5ac3be157c72">Screenshot 2025-06-06 at 01.45.19.png</a></td><td></td><td><a href="basics/customizations">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></select></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></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="geometry/buildings">buildings</a></td><td><a href="https://2449447963-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2ahel6HN9zgEzJ1vY9kr%2Fuploads%2FGrpyItrtMsQSPjRd3cMy%2Fscene-1749156132577.png?alt=media&#x26;token=1e4ce10c-b85b-418d-a00c-68e444b9ac9b">scene-1749156132577.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="geometry/barriers">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&#x26;token=6a7ba616-b45d-4094-8baa-a538bcbd8436">scene-1749156254236.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="geometry/surface">surface</a></td><td><a href="https://2449447963-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2ahel6HN9zgEzJ1vY9kr%2Fuploads%2FeS0IV4ZXQQCHGkHBOGIN%2Fscene-1749156447089.png?alt=media&#x26;token=334febc9-bd02-4bd6-8c17-8ba2705a8dd6">scene-1749156447089.png</a></td><td></td></tr><tr><td><strong>Infrastructure</strong></td><td>Surface Information</td><td><span data-option="P8roCyk5SLOJ">Nodes</span></td><td><a href="geometry/infrastructure">infrastructure</a></td><td><a href="https://2449447963-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2ahel6HN9zgEzJ1vY9kr%2Fuploads%2F7YjqYs1geLoKld4JgIE9%2Fscene-1749156460881.png?alt=media&#x26;token=c3c99b86-51fa-46eb-9af5-a8c1b9546205">scene-1749156460881.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="geometry/topography">topography</a></td><td><a href="https://2449447963-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2ahel6HN9zgEzJ1vY9kr%2Fuploads%2FKNtL7yGjVDkPK6OOqi1e%2Fscene-1749158253620.png?alt=media&#x26;token=914cac54-3162-4462-9b5d-dd0806055d70">scene-1749158253620.png</a></td><td></td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://cityweft.gitbook.io/docs/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.