Skip to main content

​
Quick Start

Creating a workspace in Auk takes just a few clicks:
1

Open Workspace Menu

Click the workspace selector in the top navigation bar
2

Click 'New Workspace'

Select “Create New Workspace” from the dropdown menu
3

Configure Workspace

Enter workspace details and choose storage location
4

Start Using

Your new workspace is ready to use immediately

​
Configuration Options

​
Basic Settings

​
name
string
required
Workspace name - use a descriptive name that reflects the workspace purposeExamples:
  • acme-corp-apis
  • personal-projects
  • client-globex
​
description
string
Optional description to provide more context about the workspace
​
location
path
required
Local file system path where workspace data will be storedDefault locations:
  • macOS: ~/Library/Application Support/Auk/workspaces/
  • Windows: %APPDATA%\Auk\workspaces\
  • Linux: ~/.config/Auk/workspaces/
Custom locations:
  • ~/Documents/Auk/my-workspace
  • ~/Projects/api-collections

​
Git Configuration (Optional)

​
gitEnabled
boolean
default:"false"
Enable Git synchronization for team collaboration
​
gitRemoteUrl
string
Remote Git repository URLExamples:
​
gitBranch
string
default:"main"
Default branch to use for synchronization

​
Creation Methods

​
Method 1: Empty Workspace

Create a completely new workspace from scratch: 
New Workspace
├── collections/        (empty)
├── environments/       (empty)
├── history/           (empty)
└── settings.json      (default settings)
Best for:
  • Starting a new project
  • Clean slate for new APIs
  • Learning and experimentation

​
Method 2: Clone from Git

Create a workspace by cloning an existing Git repository:
1

Select 'Clone from Git'

Choose this option when creating a new workspace
2

Enter Repository URL

[email protected]:team/api-collections.git
3

Choose Local Path

Select where to store the cloned workspace
4

Clone and Open

Auk clones the repository and opens the workspace
Best for:
  • Joining an existing team
  • Working on multiple machines
  • Accessing shared collections

​
Method 3: Import Existing Data

Create a workspace by importing data from other tools:
  1. Export Postman collection (v2.1 format)
  2. Create new workspace in Auk
  3. Use File → Import → Postman Collection
  4. Select exported JSON file

​
Initial Setup

After creating a workspace, configure these essential settings:

​
1. Default Environment

Set the environment that loads automatically: 
{
  "defaultEnvironment": "development"
}

​
2. Proxy Settings (if needed)

Configure HTTP/HTTPS proxy: 
{
  "proxy": {
    "enabled": true,
    "url": "http://proxy.company.com:8080"
  }
}

​
3. Interceptor Mode

Choose how Auk intercepts requests:
  • None - Direct requests (default)
  • Proxy/Agent - Use Auk Agent or proxy for CORS
  • System Proxy - System-wide proxy

​
4. Git Sync (if enabled)

Configure automatic synchronization: 
{
  "git": {
    "autoSync": true,
    "syncInterval": 900,
    "conflictResolution": "prompt"
  }
}

​
Examples

​
Example 1: Personal Project Workspace

Name: personal-apis
Description: My personal API testing workspace
Location: ~/Documents/Auk/personal
Git: Disabled

​
Example 2: Team Workspace with Git

Name: acme-corp-apis
Description: ACME Corp API collections
Location: ~/Documents/Auk/acme-corp
Git: Enabled
  Remote: [email protected]:acme-corp/api-collections.git
  Branch: main
  Auto-sync: Every 15 minutes

​
Example 3: Client Project Workspace

Name: client-globex
Description: Globex Corporation API testing
Location: ~/Projects/clients/globex/auk
Git: Enabled
  Remote: [email protected]:globex/apis.git
  Branch: development
  Auto-sync: Manual only

​
Workspace Templates

Auk provides templates for common scenarios:

REST API Testing

Pre-configured for RESTful API testing with common headers and auth

GraphQL Development

Includes GraphQL-specific settings and example queries

Microservices

Organized structure for testing multiple microservices

Mobile Backend

Configured for mobile app backend testing

​
Troubleshooting

Cause: Insufficient permissions or invalid pathSolution:
  • Ensure the directory exists and is writable
  • Check file system permissions
  • Try a different location
Cause: Authentication failure or network issuesSolution:
  • Verify SSH keys are configured correctly
  • Check repository URL is correct
  • Ensure you have access to the repository
  • Try HTTPS instead of SSH
Cause: Incompatible file format or corrupted dataSolution:
  • Verify the export file is valid JSON
  • Check the file format matches the import type
  • Try exporting again from the source tool

​
Next Steps

Switch Workspaces

Learn how to switch between workspaces

Workspace Settings

Configure advanced workspace options

Setup Git Sync

Enable Git synchronization for collaboration

Import Data

Import collections from other tools