> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cloneable.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Use Cloneable with Katapult

> Bring Katapult jobs into Cloneable, collect in the field and export the results back

Cloneable connects to Katapult Pro. Your Katapult model becomes a Cloneable configuration, your Katapult jobs come in as Cloneable jobs, crews collect in the Cloneable app, and the results go back to Katapult.

```mermaid theme={null}
flowchart LR
  A["Katapult model"] -->|"once"| B["Cloneable configuration"]
  C["Katapult job"] -->|"Import"| D["Cloneable job"]
  D --> E["Field capture<br/>Cloneable iOS app"]
  E -->|"Export"| C
```

## Before you start

* A **Katapult Pro** account with API access.
* A Cloneable **organization admin** for setup. Anyone can import and export jobs afterwards.
* Optional: the [Cloneable Chrome extension](https://chromewebstore.google.com/detail/cloneable/lhcnlckpplkmdiofklhinjjbohcocjpc), if you'd rather send the model from Katapult in your browser than use an API key.

## 1. Add your Katapult API key

Import and export use one Katapult API key for your organization. To get the key in Katapult:

1. Log in to your Katapult account.
2. At the top right, click the apps icon, just left of the user icon.
3. Click **Home**. The API key section shows there if it's enabled for your account.
4. Create a new API key or copy an existing one.

Then add it to Cloneable in one of two places:

<Tabs>
  <Tab title="When you first import">
    The first time you import a Katapult job, Cloneable asks for the key. Paste it and click **Save and continue**.

    <Frame caption="Cloneable asks for the key the first time">
      <img src="https://mintlify.s3.us-west-1.amazonaws.com/cloneable/images/katapult/api-key.png" alt="Connect to Katapult screen with instructions for finding the API key and a Katapult API key field" width="560" />
    </Frame>
  </Tab>

  <Tab title="In settings">
    Open the user menu → **Secrets vault** → **Create secrets** → **Add platform secrets** → **Katapult**. Paste the key into **Value** and click **Save all secrets**.

    <Frame caption="The Katapult key in the secrets vault">
      <img src="https://mintlify.s3.us-west-1.amazonaws.com/cloneable/images/katapult/secret-row.png" alt="Create secrets screen with a platform row named KATAPULT_API_KEY and an empty secret value field" />
    </Frame>
  </Tab>
</Tabs>

Cloneable encrypts the key and never shows it again. To replace it, edit the `KATAPULT_API_KEY` row in **Secrets vault**.

## 2. Create a configuration from your Katapult model

This builds Cloneable templates from your Katapult model's node types, connection types and attributes. You do it once per model.

Open **Settings** → **Configurations** → **New configuration** → **From a Katapult model**.

<Frame caption="Bring the model in with your API key, or send it from Katapult with the Chrome extension">
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/cloneable/images/katapult/model-import.png" alt="Import Katapult model page with an API key option and three steps for the Chrome extension" width="560" />
</Frame>

Get the model in one of two ways:

* **With your API key**: choose the model and click **Load model**.
* **With the Chrome extension**: open the model in Katapult, click the Cloneable extension and choose **Export Full Model**.

Then choose **Create new configuration** and walk through the guided setup. Each step ends with **Confirm & continue**.

<Steps>
  <Step title="Name your configuration">
    Use letters, numbers and underscores. Choose the measurement unit crews will use in the app.
  </Step>

  <Step title="Select model elements">
    Pick the node types, connection types and other elements to include.
  </Step>

  <Step title="Select attributes">
    Pick the attributes to collect for each type.
  </Step>

  <Step title="Map Katapult nodes">
    Match Katapult types to Cloneable's pole, span, span measurement and guy anchor.
  </Step>

  <Step title="Configure visualization icons">
    Choose how each type looks on the map.
  </Step>

  <Step title="Connect Katapult">
    Confirm the API key and the import and export triggers. The defaults are right for most teams.
  </Step>

  <Step title="Final review & import">
    Optionally choose a field to show as a label next to each point, such as the pole tag. Click **Complete import**.
  </Step>
</Steps>

If saving fails partway through, Cloneable offers to roll back and delete what it created, so you can start again cleanly.

<Tip>
  When your Katapult model changes, open the configuration's **⋯** menu and choose **Edit Katapult selections…**, or import the model again and choose **Update existing configuration**.
</Tip>

## 3. Import Katapult jobs

On the dashboard, click **Add job** and choose **Import from Katapult**.

<Frame caption="Choose Import from Katapult">
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/cloneable/images/katapult/job-type.png" alt="How would you like to create your job screen with Import from Katapult, Create blank job and Import from KML" width="560" />
</Frame>

<Steps>
  <Step title="Select Katapult jobs">
    Choose one or more jobs from your Katapult account. Each becomes its own Cloneable job, named after the Katapult job. With one job selected you can change its name.
  </Step>

  <Step title="Select configuration">
    Choose the configuration built from that job's Katapult model. Badges show which configurations match the model. If you **Link configuration**, future jobs on the same model pick it automatically.
  </Step>

  <Step title="Review and create">
    Check the details and click **Create job and start import**, or **Create N jobs and start imports** for several.
  </Step>
</Steps>

The import runs in the background and can take a few minutes for large jobs. When you import several jobs, they run one after another and the list shows each one's status. If one shows **Not confirmed**, click **Check again** before importing it a second time.

<Note>
  Importing a Katapult job again adds anything new in Katapult. It doesn't update objects already in Cloneable or remove anything.
</Note>

## 4. Export to Katapult

Export after crews have finished and their phones have synced, so every photo has uploaded.

<Steps>
  <Step title="Open the job on the map">
    Click **Export data** in the map toolbar and choose **Export to Katapult**.
  </Step>

  <Step title="Decide about deleted items">
    If items were deleted in Cloneable but still exist in Katapult, choose **Export only** to leave them in Katapult, or **Export and delete** to remove them from Katapult first. Deleting in Katapult can't be undone.
  </Step>

  <Step title="Start the export">
    Click **Export to Katapult**, then **Run trigger** to confirm.
  </Step>
</Steps>

Only objects that changed since their last export are sent, so exporting again is safe and fast.

### Export a single object

Click the object on the map, open its **History** tab and switch to **Exports**. Use **Export** → **Export updates** to send new data, or **Force export all** to send everything again. Force export can create duplicates in Katapult, so use it only when asked to.

## 5. Check export status and issues

The dashboard's **Exports** tab shows what's exporting now and any exports that didn't finish.

<Frame caption="Export status and export issues">
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/cloneable/images/katapult/exports-tab.png" alt="Exports tab with an Export status card and an Export issues list with filters" />
</Frame>

Open an issue to see **What happened** and **What you can do**. When it's fixed, export again and **Mark resolved**. Common issues and fixes are in [Troubleshooting](/guides/integrations/katapult/troubleshooting).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.