# SketchUp

## Supported SketchUp Versions

Cityweft is compatible with SketchUp 2019 and all later versions, including SketchUp 2020, 2021, 2022, 2023, 2024, 2025, and 2026. Both macOS and Windows are fully supported.

#### Supported Operating Systems

* **Windows**
* **macOS**

## Activating Plugin

A **valid Cityweft API key** is required to use the plugin.

API keys can be generated and managed from your **Cityweft API Dashboard**.

For detailed instructions on how to obtain and manage your API key, see the section:

{% content-ref url="/pages/HqcxKmhLQ8veekNvfhTq" %}
[Getting your API key](/docs/plugins/getting-your-api-key.md)
{% endcontent-ref %}

## **Getting Started**

Before getting started, ensure you have followed the instructions for both installation and API key access.

### 🔑 **Activating your API Key**

To activate the plugin the first time, you need to enter your API key. If you do not have this, please visit the **‘Getting your API Key’** page

1. Once you have retrieved your API key, simply go to the usage tab and find the ‘Set API Key’ button<br>

   <figure><img src="/files/Kuq6inCt8IL2QmbfZx3n" alt=""><figcaption><p>Press "Set API Key"</p></figcaption></figure>

2. Paste your API Key into the field and press ‘OK’

   <figure><img src="/files/tY9GZYxtCiiYhwpRiAGE" alt=""><figcaption></figcaption></figure>

3. Once input correctly, you will see your account and subscription status, which means you are ready to go!

### 🏢 **Getting Your Model**

1. In the Cityweft window, **navigate or search** for your desired site location.<br>

   <figure><img src="/files/eXJ814iCm375XX26KIlq" alt=""><figcaption></figcaption></figure>

2. **Select an area** on the map using the polygon selection tool.<br>

   <figure><img src="/files/fFudLLTkVaUKBEFDpWuT" alt=""><figcaption></figcaption></figure>

3. **Press the ‘Import to SketchUP’ button**\
   \
   The model will automatically appear in the viewport\
   If you are selecting a large area with dense geometry, this process can take up to 1-2 minutes.<br>

   <figure><img src="/files/0SzBWx5rYH1hnxGKsTNc" alt=""><figcaption></figcaption></figure>

4. **View all the model layers in the tags window**<br>

   <figure><img src="/files/cUNoz1IWottzqU4YuQFB" alt=""><figcaption></figcaption></figure>

### ⚙️ Plugin **Settings Overview**

The Cityweft SketchUp plugin includes several settings that control what data is included and how it is processed when generating models.

These are grouped into two main categories:

***

#### **1. Layers to import**

*(Check boxes — choose which layers to include in your model)*

These options let you define which geometry types to include when downloading the model.

| **Option**         | **Description**                                                        |
| ------------------ | ---------------------------------------------------------------------- |
| **Buildings**      | Imports buildings and roof geometry.                                   |
| **Surface**        | Includes ground surfaces such roads, green space, or base mesh.        |
| **Barriers**       | Adds physical boundaries like fences, retaining walls, or embankments. |
| **Topography**     | Imports detailed elevation data and terrain contours.                  |
| **Infrastructure** | Adds infrastructure layers such as trees, bus stops, or benches        |

> 💡 Tip: If you only need building geometry, uncheck other layers to speed up processing.

***

#### **2. Default building settings**

*(Adjustable fields — define defaults for missing data)*

| **Setting**          | **Description**                                                                                                                  |
| -------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| **Roof Types**       | Sets a default roof geometry type for buildings that lack roof data. This does **not** override existing roof shape information. |
| **Levels**           | Specifies how many building levels to assign when no height data is available.                                                   |
| **Level Height (m)** | Defines the assumed height of each building level in meters. Used to estimate total building height when no data exists.         |

> 🏗️ These settings ensure that all buildings generate correctly, even when data is incomplete.


---

# 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/plugins/sketchup.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.