Add SDK examples – Mintlify

Add SDK code samples to your API documentation with autogenerated examples from Speakeasy and Stainless across multiple languages.

If your users interact with your API through an SDK rather than direct network requests, add SDK code samples with the x-codeSamples extension. Mintlify displays these samples on your OpenAPI pages.

Add this property to any request method. It has the following schema.

langstringrequired

The language of the code sample.

labelstring

The label for the sample. This is useful when providing multiple examples for a single endpoint.

sourcestringrequired

The source code of the sample.

The following example shows code samples for a plant tracking app that has both a Bash CLI tool and a JavaScript SDK.

paths:
  /plants:
    get:
      # ...
      x-codeSamples:
        - lang: bash
          label: List all unwatered plants
          source: |
            planter list -u
        - lang: javascript
          label: List all unwatered plants
          source: |
            const planter = require('planter');
            planter.list({ unwatered: true });
        - lang: bash
          label: List all potted plants
          source: |
            planter list -p
        - lang: javascript
          label: List all potted plants
          source: |
            const planter = require('planter');
            planter.list({ potted: true });