Upload API documents

This guide will help you interact with our registry with our dashboard on scalar.com, which can be done alongside our command-line interface.

Make sure you have created a Scalar Account & are logged in (see create account guide)

Add an API Document

Now let's add an API document to the registry ✨

From the dashboard click Import API from the right hand pane, or navigate to registry in the sidebar under Products then click Create new API

You can upload any version of OpenAPI or AsyncAPI (even Swagger) or a Postman Collection!

Awesome, now your API document is in the Registry under your company's namespace!

Update an API Document

You can use our OpenAPI Editor to make changes to your API document, or click Edit Document from the Registry Page.

Once you make edits, you can click Publish in the top right to upsert a new version to the registry

Delete an API Document

You can delete an API document from the Registry > Overview page, however please consider the downstream effects of which products are depending on that API document before deleting that resource.