Skip to content

// DOCUMENTATION

Export OpenAPI

Download the saved workspace definition as validated OpenAPI JSON and resolve export errors.

Export the saved definition

Save pending editor changes. Open Settings > Export OpenAPI and download the JSON file. The export uses the saved workspace definition and requires workspace access. Only JSON output is supported.

GET /api/workspaces/{workspaceId}/openapi/export?format=json

Errors and warnings

401 requires signing in. A missing or inaccessible definition returns 404. An unsupported format returns 400. Invalid designs or definitions larger than the 8 MiB limit return 422; fix the reported paths and retry. Export has a 30-second timeout, returning 408 when exceeded.

Warnings appear in the export UI and may be included as x-rest-test-export-warnings in the JSON. Review them before consuming the document. Export is a contract snapshot, not a guarantee that the target API implements it.

// GET STARTED

Bring your API workflow into one workspace.

Start with an OpenAPI or Swagger JSON definition and keep the workflow together.

Start for free