SDK Creation Overview
Stages of availability
✅ GA: Available for self-service use, has full support for all available features. Support subscribes to SLAs.
🔵 Beta: Available for self-service use, may not support all generation features (see language page for details). Support subscribes to SLAs.
🏗️ Alpha: Available via CLI, all feature support is experimental. Support does not subscribe to SLAs.
To get started with Speakeasy SDK creation, you will need an API spec in one of our supported formats:
These instructions are for creating SDKs using the managed pipeline in the web app. If you prefer to set up the CI/CD using a GitHub action, you can find instructions here.
Log in to the Speakeasy web app (opens in a new tab). If you don't have a workspace yet, you'll be prompted to create one.
You may upload your spec as a local file or publicly hosted URL.
If your spec is hosted on GitHub, make sure you are linking to the raw URL:
Select the languages you will generate SDKs for. For more information about the design of each SDK language, check out the SDK design section.
Once you've selected the languages you want to generate for, click the Start Generating button to kick off the SDK generation process. Your SDK will be created in a repo in the
speakeasy-sdks GitHub organization.
Generating SDKs is the first step, but there are several optimizations you can make to improve the quality of your SDKs. We recommend you check out the following guide on customizing your SDKs.