RESTKDocs

Import & Export

Import API collections from Postman, OpenAPI, and cURL. Export in RESTK, Postman, or OpenAPI format.

8 min read

Import existing API collections and requests from other tools to get started quickly. RESTK supports importing from Postman, OpenAPI, and cURL commands, with multi-file import for bulk migration.

Quick Start

Click Import

Click the Import button in your workspace

Choose Format

Select Postman Collection, OpenAPI, or cURL

Provide Data

Upload a file or paste your cURL command

Review & Import

Preview the import and click Import to complete


Supported Import Formats

FormatFile TypesNotes
Postman Collection.postman_collection.jsonv2.1 only
Postman Environment.postman_environment.jsonVariables including secrets
OpenAPI.json, .yamlOpenAPI 3.x specifications
cURLPasted textSingle command per import

Postman v2.1 Only

RESTK supports Postman Collection v2.1 format only. Older v2.0 exports are not accepted. If you have a v2.0 file, re-export from Postman using the v2.1 format.


Importing Postman Collections

Basic Import

Prepare Export

Export your collection from Postman as JSON (v2.1 format)

Start Import

Click Import and select Postman Collection

Choose File

Select your exported JSON file

Preview

Review the collection name, request count, and folder count

Confirm Import

Click Import to create the collection

Import Preview

The preview screen shows accurate counts for requests, folders, and variables before you import.

What Gets Imported

Collection Structure:

  • Collection name and description
  • Folder hierarchy (all nesting levels preserved)
  • Request order within folders
  • Collection variables

Request Details:

  • URL and HTTP method
  • Headers (including disabled headers)
  • Query parameters (including disabled parameters)
  • Request body (JSON, form data, URL encoded, raw)
  • Authentication settings (Bearer, Basic, API Key, Inherit)

Script Auto-Conversion

By default, RESTK automatically converts Postman pm.* scripts to the nova.* API during import.

Example conversions:

  • pm.variables.set()nova.variable.set()
  • pm.expect()nova.expect()
  • pm.response.json()nova.response.json()

The import preview shows "Will be transformed to nova.* API" when auto-conversion is enabled.

Script Conversion Toggle

Script auto-conversion is enabled by default. You can disable it in the import options if you prefer to convert scripts manually.

Variables

Collection Variables:

  • Imported into the collection's variable section
  • Keys and values preserved
  • Available for use immediately

Environment Variables:

  • Variable references ({{variable}}) preserved in requests
  • Postman environment files import directly as RESTK environments
  • Variable syntax remains intact

Environment Import

Postman environment files (.postman_environment.json) are imported automatically when you drop them in. Variables, including secret types, are preserved.


Importing from OpenAPI

Import OpenAPI 3.x specifications to generate request collections from your API definitions.

Get OpenAPI Spec

Obtain the OpenAPI specification file (JSON or YAML)

Import in RESTK

Click Import, select OpenAPI, and choose your file

Preview and Confirm

Review the generated collection structure and click Import


Importing cURL Commands

Basic cURL Import

Copy cURL

Copy your cURL command from any source

Start Import

Click Import and select cURL

Paste Command

Paste the cURL command into the text field

Import

Click Import to create the request

cURL Examples

Simple GET:

curl https://api.example.com/users

POST with JSON Body:

curl -X POST https://api.example.com/users \
  -H "Content-Type: application/json" \
  -d '{"name": "John", "email": "[email protected]"}'

With Basic Auth:

curl https://api.example.com/users \
  -u admin:password

cURL Features Supported

FeatureImport Support
HTTP methods (-X)Yes
Headers (-H)Yes
JSON body (-d)Yes
Form data (-F)Yes
URL encoded (--data-urlencode)Yes
Query parametersYes
Basic auth (-u)Yes
Bearer tokenYes (via header)

Importing Multiple Files

When you drag and drop multiple files, RESTK offers two import modes.

Separate Collections

Each file becomes its own collection:

Drop Multiple Files

Drag and drop multiple files into the import area.

Choose Separate Collections

Select Separate Collections mode. Each file creates an independent collection.

Review File Analysis

The preview shows each file with its name, format, request count, folder count, and variable count. Deselect any files you don't want to import.

Import

Click Import. Progress shows which file is being processed (e.g., "2 of 5").

Single Collection (Merge)

All files merge into one collection:

Choose Single Collection

Select Single Collection mode and enter a name (default: "Imported Collection").

Import

Each file becomes a top-level folder inside the merged collection, with all its requests and subfolders.

Skipped Files

Some files may be skipped during multi-file import. The completion screen shows a count (e.g., "2 files skipped") with reasons for each:

Skip ReasonDescription
Unknown formatFile format could not be detected
Invalid JSONFile contains malformed JSON syntax
Unsupported versionFormat version not supported (e.g., Postman v2.0)
Empty fileFile has no content
File too largeFile exceeds the 50MB size limit

Partial Success

Valid files import successfully even if some files are skipped. Check the completion summary for details.


Exporting Collections

Export collections for sharing, backup, or migration to other tools.

How to Export

Right-Click Collection

Right-click a collection in the sidebar and select Export.

Choose Format

Select the export format:

  • RESTK (.restk.json) — Full feature support, recommended for backup and sharing
  • OpenAPI (.openapi.json) — Standard OpenAPI 3.x specification
  • Postman Collection (.postman_collection.json) — For sharing with Postman users

Configure Options

Toggle what to include in the export.

Save File

Click Export and choose where to save. Use Show in Finder to locate the file.

Export Options

OptionDefaultDescription
Mask Sensitive ValuesOnVariables marked as secret are masked
Include ScriptsOnPre-request and post-response scripts
Include AuthOnAuthentication configuration
Include VariablesOnCollection variables
Pretty PrintOffFormat JSON with indentation

OpenAPI Limitations

OpenAPI format does not support scripts, auth, or variables. These options are disabled when exporting to OpenAPI.

Export Presets

Use presets for common export scenarios:

PresetMask SecretsDescription
For SharingOnSafe to share — sensitive values masked
For BackupOffComplete backup with all data in plaintext

Exporting Environments

Right-click an environment and select Export to save it as a .restk_env.json file containing only variables.

Postman-compatible environment export (.postman_environment.json) is also available.


Import Options

File Size Limit

Import files are limited to 50MB. Files exceeding this limit are rejected with a "File too large" error.

Import Location

Imports are created in your currently selected workspace:

  • Select the workspace before importing
  • The collection appears in that workspace

Permissions

You need Editor permissions or higher to import collections. Viewers cannot import.

Offline Import

You can import while offline:

  • The collection is created locally
  • When you reconnect, the collection and all its contents sync to the server

Error Handling

Invalid JSON

If the import file has invalid JSON:

  • Error message: "Invalid JSON format"
  • No partial import occurs

Unsupported Format

For unrecognized or unsupported formats:

  • Error: "Unsupported format"
  • Suggestion to check format compatibility

Invalid cURL

For malformed cURL commands:

  • Error: "Invalid cURL syntax"
  • No request created

Best Practices

  1. Use v2.1 Format — Export Postman collections in v2.1 format (v2.0 is not supported)
  2. Check Preview — Always review the import preview before confirming
  3. Verify After Import — Test a few imported requests to ensure they work correctly
  4. Check Environments — Postman environment files import automatically; verify variable values are correct
  5. Use Multi-File Import — Drag and drop multiple files at once for bulk migration
  6. Keep Auto-Conversion On — Let RESTK auto-convert Postman scripts to the nova.* API

Troubleshooting

Request Body Missing:

  • Check that the Postman export includes request bodies
  • Verify JSON format is valid

Scripts Not Working After Import:

  • Check if script auto-conversion was enabled during import
  • If disabled, manually convert pm.* calls to nova.* — see the Scripting docs

Variables Not Resolving:

  • Ensure the Postman environment file was imported alongside the collection
  • Check that the imported environment is set as active in your workspace

Auth Not Working:

  • Verify auth type was set in Postman before export
  • Check that tokens/credentials are valid

Next Steps