Generating an SDK
Generating an SDK takes a spec, a language, and a build. Everything else is refinement.
- Upload a spec
Point Octri at an OpenAPI 3.x document. Upload the file, paste a URL, or sync it from a GitHub repository so every push regenerates.
- Shape the client
Open SDK Studio. Set the auth scheme, decide how methods are named and grouped, and set the base URL your users should hit. See Client shape.
- Pick languages
Each language you enable is generated independently, so one failure does not block the rest. Your plan includes a number of languages, from one on Free to all ten on Business, and extras are a flat monthly add-on. See plans and limits.
- Build
Octri generates every enabled language and stores the result as a downloadable artifact.
- Download or publish
Download the zip, or connect a registry account and let Octri publish the release. See Publishing.
Before you build
Two settings decide whether the generated client is usable on day one.
Endpoint inclusion
Internal and admin endpoints usually do not belong in a public client. Exclude an endpoint and it disappears from every generated language, and from the MCP server's operation tools.
On plans with an endpoint limit, the first N endpoints are enabled automatically and the rest are excluded. Changing an endpoint's inclusion stores an explicit override, so your choice survives a re-import.
Validation
Octri validates the spec before generating. A spec that parses but describes the API badly still generates badly, so it is worth fixing the source rather than patching the output:
The generator derives method names from each operation's operationId. When one is missing, the name is derived from the method and path, which reads like postV1UsersUserIdContact. Add operationId to the spec, or override the name per endpoint in Studio. See Client shape.
Everything downstream inherits the spec's quality. The spec audit publishes all fourteen rules it scores against, and what each one costs a generated client. Ten habits for writing great OpenAPI specs collects the choices that pay off most in the generated output.
What ships in the package
Every generated SDK includes typed models, the auth scheme, retries and timeouts, idempotency keys on writes, and a README. Add a generated CLI if you want a runnable command per operation.
From the CLI
octri sdk validate, octri sdk preview and octri sdk build run each step. octri lab run runs them all and keeps the output, so you can diff two builds.
Naming, namespacing, argument style, file layout.
Errors, tests, the mock server and the file layout.
Each setting with its key, values and default.
The causes by check, and how to fix each one.
Install, options, and conventions per language.