Guides

Exporting your spec

Download as JSON / YAML / AsyncAPI, or copy to clipboard.

Updated

The export panel sits at the bottom of every spec view. It always reflects the current state of the spec — no “save before export” dance.

JSON or YAML

Toggle the format and you can:

  • Copy to clipboard.
  • Download as <spec-title>.json or <spec-title>.yaml.

Both are post-processed: trailing whitespace cleaned, optional fields stripped where empty, and $refs preserved (not inlined).

AsyncAPI YAML

When your spec contains at least one WebSocket endpoint, an AsyncAPI button appears. It downloads <spec-title>.asyncapi.yaml — an AsyncAPI 3.0 document covering only the WS portion of your spec. Use it with:

  • AsyncAPI codegen (TypeScript, Java, Python, etc.).
  • AsyncAPI Studio, AsyncAPI HTML renderer.
  • Any AsyncAPI 3.0-aware tooling.

See WebSocket endpoints.

Hotlinks are the right answer when you want a stable URL that always returns the latest version of your spec. Read Sharing via hotlinks.

API contract — what’s included

The exported document includes:

  • info, servers, tags, externalDocs
  • All paths and operations
  • components.schemas, securitySchemes, parameters, responses, requestBodies, examples
  • WebSocket extensions (x-protocol, x-channel, x-messages, etc.)
  • Operation x-updated-at extensions (a small audit trail of when each operation last changed)

What’s not included:

  • Workspace credentials (these never leave the workspace).
  • Header profiles (those are runner state, not spec state).
  • Execution history.

Programmatic access

Treat your spec as a deploy artefact: a hotlink in CI fetches the latest, your codegen step consumes it, and a release pipeline runs a recipe smoke test against staging. See Sharing via hotlinks.