Importing a spec
Everything in Octri builds from your spec, so importing one is the first step. You can bring an OpenAPI file from wherever it lives, convert another format, or switch from another platform.
Ways to import
| Method | Use it when |
|---|---|
| GitHub repo | Your spec is in a repository. Octri can sync it on every push |
| Upload a file | You have an OpenAPI JSON or YAML file on your computer |
| From a URL | Your API serves its spec at a URL |
| Paste it | You have the raw JSON or YAML to hand |
| Switch to Octri | You are moving from Speakeasy, Stainless, Fern, liblab or Mintlify |
| Try an example | You want to see the whole flow on a ready-made spec |
| Start from scratch | You don't have a spec yet. Octri gives you an empty one to build on |
From the CLI, use octri specs import or octri specs push.
What Octri accepts
| Format | What happens |
|---|---|
| OpenAPI 3.0, 3.1 and 3.2 | Read as it is, in JSON or YAML |
| Swagger 2.0 | Upgraded to OpenAPI 3 |
| Postman Collection | Translated to OpenAPI 3.1 |
| AsyncAPI | Translated to OpenAPI 3.1 |
For anything else, convert first. The free Spec Converter also takes RAML, Insomnia, HAR, cURL, GraphQL, gRPC and WSDL, and lists every change the conversion makes.
To check a spec before importing it, use the OpenAPI Parser, which validates, bundles and dereferences it.
Larger files are refused. Most specs that big carry long inline examples, which are the first thing to move out.
What happens after you import
- Validation
Octri checks the spec before generating anything. If it can't be read, you see why and nothing changes.
- Your base URL and auth are detected
Octri fills in the playground's base URL and default authentication from what the spec declares. You can change them in the playground settings.
- Your pages are generated
Each endpoint your plan covers gets a reference page. You can leave while this runs.
Then use Spec Audit to see what could be better.
Switching from another platform
Drop your export from Speakeasy, Stainless, Fern, liblab or Mintlify onto Switch to Octri. Octri reads it and shows you a preview of what it found, such as your SDK languages, package name and per-endpoint settings.
The site has a step-by-step migration guide for each of them.
Keeping it current
A spec does not have to be imported by hand each time. Spec sync can bring in updates from GitHub or a URL, and decide whether they go live on their own.