Migration guide

Migrate from Scalar to Octri

The move starts from two things a Scalar project already has: the OpenAPI document its reference is built from, and its guides as Markdown and MDX.

Written by Octri · Checked 25 October 2026

What to have to hand

Your OpenAPI file, and your Markdown in a GitHub repository. Everything else is set in API Studio and SDK Studio.

  • openapi.json
  • guides/*.mdx

What comes across

Scalar has no config for Octri to read, so the move runs on files you already have. Rows marked “By hand” are what is left for you.

WhatIn OctriFrom Scalar
API referenceA page for every endpoint, written for youYour OpenAPI file
GuidesPage drafts, by Pull from GitHubYour Markdown and MDX in Git
Redirectsoctri.jsonYour Scalar redirects, by hand
Logo, colours and fontsSet in API StudioBy hand
SDKsGenerated in the languages you pickNothing to bring

Step by step

  1. Bring the spec

    Sign up and upload the OpenAPI document from your Scalar registry, or connect the repository it lives in.

  2. Pull your guides from GitHub

    Connect the repository that holds your Scalar guides, then choose Pull from GitHub in the API Studio Files panel. Pick up to 50 Markdown or MDX files at a time and each lands as a page draft, with its title, description, icon and badge taken from the frontmatter. Switch on sync on push and later edits in Git keep landing on the same pages.

  3. Set up your SDKs

    Pick your languages in SDK Studio. If you publish Scalar SDKs today, give each language the same package name. Give each language the package name your users already install, and publish the first Octri release as a new major version, since method names and types can change. Every later spec change arrives in the SDK repository as a pull request.

  4. Keep your old links working

    Open octri.json in the Files panel and add a redirect for each old path. A rule that ends in /* covers a whole section, and a project keeps up to 500 of them.

  5. Go live

    Publish, then point your custom domain at Octri last, so readers keep the old site until the new one is ready. From then on every merged spec change rebuilds the draft of your docs, SDKs and MCP tools, ready for you to publish.

Questions

No. The importer only reads the files you upload, and Pull from GitHub only reads your repository. Nothing is written back to either, so your current site keeps running until you move the domain.

Still deciding?

The comparison sets Octri against Scalar row by row, from each product’s own pages, with Octri’s prices beside them.

Try it on your own spec

Bring what you have from Scalar on the Free plan and see your reference written and your first SDK built.