Create a new API specification

Spec Hub is available with Postman Enterprise plans.

Create a specification in Spec Hub to design and test your API's structure. You can create a specification in OpenAPI 3.0 or AsyncAPI 2.0 format. Then you can share your specification with collaborators.

You can also import an OpenAPI 3.0 or AsyncAPI 2.0 specification into Spec Hub.

Show specifications in the sidebar

By default, specifications aren't visible in the Postman sidebar. You can change this in your workspace settings.

  1. Select the name of the current workspace in the sidebar, then select the Settings tab in the workbench.
  2. Under Configure sidebar, turn on the toggle next to Specs.
  3. Select Specs in the sidebar to view and work with specifications.

Create a new specification

You can create OpenAPI 3.0 and AsyncAPI 2.0 specifications in Spec Hub. You can also import an existing OpenAPI 3.0 or AsyncAPI 2.0 specification into Postman.

  1. Select Specs in the sidebar.

  2. Select Add icon Create new specification and select the type of specification you want to create (OpenAPI 3.0 or AsyncAPI 2.0). Postman creates a new specification with boilerplate content.

    Create a new specification
  3. To rename your specification, select Options icon View more actions next to the specification in the sidebar and select Rename. Type a new name and select Return or Enter.

    You can also rename the specification file. Select the filename in the workbench, enter a new name, and select Return or Enter.

  4. Edit or replace the content in the specification as needed for your API. Learn more about editing your specification.

You can't change the specification type (OpenAPI 3.0 or AsyncAPI 2.0) after creating a specification. Create a new specification instead.

Share a specification

You can share a specification with collaborators. Select Specs in the sidebar and select a specification. Then select Link icon Copy link to file in the workbench.

Copy a link to a specification

For more details about sharing elements, see Share your work in Postman.

Rename a specification

  1. Select Specs in the sidebar.
  2. Next to your specification, select Options icon View more actions > Rename.
  3. Enter a new name for your specification.
  4. Select Return or Enter.

Delete a specification

  1. Select Specs in the sidebar.
  2. Next to your specification, select Options icon View more actions > Delete.
  3. Select Delete to confirm.

Last modified: 2025/03/17