> For the complete documentation index, see [llms.txt](https://doc.wearepatchworks.com/product-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.wearepatchworks.com/product-documentation/developer-hub/openapi-and-postman-importer.md).

# OpenAPI & Postman importer

## Introduction

The **collection importer** builds a connector from an existing API specification, so you don't have to configure everything by hand. You can import from:

* an **OpenAPI / Swagger** specification - upload a file or provide a URL
* a **Postman** collection - upload a file or provide a URL

From your spec or collection, the Patchworks importer will then attempt to:

* create the system/connector
* create system variables
* create the authentication type (OAuth 1 & 2; Token; API key; Basic)
* create authentication variables
* create endpoints (including variables)
* enable the authentication type for all endpoints

{% hint style="info" %}
These are all the elements of a connector that you would expect to configure by using the [Connector Builder](/product-documentation/developer-hub/connector-builder.md) to build your connector manually.
{% endhint %}

Prefer to start from a plain-language description rather than a spec? The Implementation Agent can build a connector for you from a prompt - see [Connector Builder AI](/product-documentation/ai/patchworks-ai-studio/platform-agents/implementation-agent.md#connector-builder).

## Need to know

* Supported formats are **OpenAPI / Swagger** (JSON or YAML) and **Postman** collections. OpenAPI files can be imported directly - there's no need to convert them to a Postman collection first.
* Large collections (roughly **4.5MB** and above) are processed in the background, so the import completes reliably even for big specs.

## Using the Postman importer

**Step 1**

\
Locate the OpenAPI / Swagger spec or Postman collection that you want to use - either a file on your local or network drive, or a URL to the collection.

**Step 2**

\
Log into the Patchworks dashboard and open **Manage Connectors**, then select **Create new connector**:

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

**Step 3**

\
This opens the **Discover** step. Beneath the AI prompt box, under **or start manually**, choose **Import OpenAPI** or **Import Postman**:

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

**Step 4**

\
Choose whether to provide a **file upload** or a **URL**, then supply your collection:

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

Selecting the **File upload** option prompts you to choose a file. Click the **Choose file** button to locate and select the required file on your local or network drive. Once selected, the file is uploaded and the filename is confirmed.

Selecting the **URL** option prompts you to provide a URL. Enter the full URL to your spec or collection.

**Step 5**

Choose an **Import mode**. This controls how the importer handles any endpoints that already exist with the same name:

* **Update existing endpoints** - create new endpoints, and update any that already exist with the same name.
* **Import new endpoints only** - skip any endpoint that already exists with the same name.
* **Overwrite all endpoints** - delete all existing endpoints for this connector before importing.

**Step 6**

\
Click the **Import** button. Patchworks imports your spec or collection, creates the connector, and takes you through the remaining setup steps shown in the left-hand rail - **Review & edit**, **Authenticate**, and **Deploy**.

**Step 7**

\
Any setup that the importer could not complete is flagged so you can add it manually. You can now edit the connector, complete anything that was left, and deploy it.

For information on connector setup options please see [Building your own connector](/product-documentation/developer-hub/connector-builder/building-your-own-connector.md).