Insomnia logo
  • Documentation
  • Get Started for Free
    • Introduction to Insomnia
    • Install Insomnia
    • Send Your First Request
    • Import and Export Data
    • Environment Variables
    • Global Environments
    • Insomnia Accounts
    • Forgotten Passphrase
    • Managing E2EE (End-to-End Encryption)
    • Organizations
    • Enable Enterprise membership
    • Configuring EE SSO
    • Integrating Insomnia Enterprise with Okta SAML 2.0
    • Integrating Insomnia Enterprise with Okta OpenID Connect
    • Integrating Insomnia Enterprise with Microsoft Azure/Entra ID SAML 2.0
    • Insomnia Whitelisting Guide for Enterprise Users
    • Transfer enterprise organizations and license
    • Configuring SCIM
    • Multiple Owners
    • Manage Domains
    • Invite Controls
    • Storage Controls
    • Session Report
    • Insomnia Subscriptions
    • Insomnia Subscription Management
    • Scratch Pad Tutorial
    • Requests
    • Responses
    • Request Collections
    • Request Timeouts
    • Chaining Requests
    • Post CSV Data
    • SOAP Requests
    • gRPC
    • WebSocket Support
    • Get Started with Documents
    • Design Documents
    • Linting
    • GraphQL for OpenAPI
    • Migrate from Designer
    • Unit Testing
    • Stress Testing
    • Insomnia Storage Options Guide
    • Sync with Insomnia Cloud
    • Sync with Git
    • Key Security Features
    • Security Standards
    • Signup and Authentication
    • Analytics Collected
    • End to End Data Encryption
    • Software Bill of Materials
    • Verifying Build Provenance for Signed Insomnia Binaries
    • Authentication
    • Client Certificates
    • Collection Runner
    • Generate Code Snippet
    • Cookie Management
    • Encoding
    • GraphQL Queries
    • Run in Insomnia Button
    • Key Maps
    • Proxy
    • Folder-level settings
    • Introduction to Plugins
    • Context Object Reference
    • Template Tags
    • Hooks and Actions
    • Custom Themes
    • AI Runner
    • FAQ
    • Application Data
    • SSL Validation
    • Password Recovery
    • Introduction to Inso CLI
    • Install Inso CLI
    • CLI Command Reference
      • inso run test
      • inso run collection
      • inso lint spec
      • inso export spec
      • inso script
      • Using Custom Linting with Inso CLI
    • Configuration
    • Inso CLI on Docker
    • Software Bill of Materials
    • Verifying Signatures for Signed Inso CLI Images
    • Verifying Inso CLI Build Provenance
      • Verifying Build Provenance for Signed Inso CLI Images
      • Verifying Build Provenance for Signed Inso CLI Binaries
    • Continuous Integration
    • Insomnia Pre-request Script Overview
    • Insomnia After-Response Script Overview
    • Secret Environment Variables
    • External Vault Integration (Enterprise feature)
    • Insomnia API Mocking Overview
    • Enterprise Login Report

Design Documents

Design Documents (also called Documents) are a space to work with API specs - from designing to debugging to testing - all within Insomnia.

Find Your Documents

Documents are accessible through the Dashboard of your Project.

If you don’t see a Document or Collection you’re looking for, ensure you’re in the right Project by clicking on the Insomnia dropdown menu. Note that the dropdown title will be Insomnia if you’re in the default Project.

Click Dashboard in the upper left-hand corner to return to a listing of your Documents and Collections. From inside a Document or Collection, return to your listings by clicking on your Project name. In this case, the Project name is Insomnia.

For information about working with Collections, see Request Collections.

Create a New Design Document

  1. Go to the Dashboard.
  2. Click the Create button in upper right hand corner.
  3. From the dropdown menu, select Design Document or a method of importing.
    • If you selected Design Document, enter a Document name and click Create. Spaces and special characters are allowed in your Document name.
    • If you selected a method of importing, a modal will open prompting you to import your Document.

Rename a Design Document

Rename a Design Document from either the Dashboard or from within a Design Document.

Rename From the Dashboard

  1. Open the action menu (visualized by the three dots) on the document you wish to rename.
  2. Select Rename action.
  3. Rename the document.

Rename From Inside a Design Document

  1. Click on the dropdown arrow next to the Document name.
  2. Click Document Settings.
  3. Rename the document. It will auto-save.

Edit a Design Document

Access Editor Mode for a Design Document from the Dashboard.

  1. Go to the Dashboard.
  2. Click on the Document to get to Editor Mode.

Delete a Design Document

Delete a Design Document from either the Dashboard or from within a Design Document.

Delete From the Dashboard

  1. Go to the Dashboard.
  2. Open the action menu (visualized by the three dots) on the document you wish to rename.
  3. Click Delete.
  4. Confirm you want to delete the Document.

Delete From Inside a Design Document

  1. Click on the dropdown arrow next to the Document name.
  2. Click Document Settings.
  3. Click Delete.
Edit this page
Report an issue
    COMPANY
  • Insomnia
  • Blog
  • Changelog
  • Pricing
  • Careers
    PRODUCTS
  • Insomnia
  • Inso (CLI)
    RESOURCES
  • Sign In
  • Documentation
  • Support
    LEGAL
  • Privacy Policy
  • Terms & Conditions
© Kong Inc. 2021