Skip to main content
Speakeasy allows you to automatically generate SDK code snippets and display them in your API playground. Here’s how to set it up:

1. Configure Your SDK Repository

Add the following to your .speakeasy/workflow.yaml file in your SDK repository:
.speakeasy/workflow.yaml

2. Set Up Your Docs Repository

The easiest way to set up your docs repository is through the Speakeasy CLI:
Follow the prompts to:
  1. Set up your source OpenAPI spec
  2. Add the code snippet overlay
  3. Configure the output specification path

3. Add Your API Key

Add your SPEAKEASY_API_KEY as a repository secret:
  1. Go to your Mintlify repository’s Settings > Secrets & Variables > Actions
  2. Add the key from your Speakeasy dashboard’s API Keys tab

Manual Setup (Alternative)

If you prefer manual setup, create these files in your docs repository:
.speakeasy/workflow.yaml
.github/workflows/sdk_generation.yaml