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.

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.