> ## Documentation Index
> Fetch the complete documentation index at: https://omer-914cc1c6.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Speakeasy

> Automate your SDK usage snippets in the API playground

Autogenerated code snippets from Speakeasy SDKs can be integrated directly into Mintlify API reference documentation. SDK usage snippets are shown in the [interactive playground](/api-playground/overview) of Mintlify-powered documentation sites.

<Frame>
  <img src="https://mintcdn.com/omer-914cc1c6/fcMjNrr23zmS_VHA/images/speakeasy/mintlify-with-speakeasy-openapi.png?fit=max&auto=format&n=fcMjNrr23zmS_VHA&q=85&s=ac9cb2d3f3a67c08dcd8c5e199bc42dc" alt="A Mintlify API playground with Speakeasy code snippets." width="2560" height="1440" data-path="images/speakeasy/mintlify-with-speakeasy-openapi.png" />
</Frame>

## Prerequisites

To integrate Mintlify with Speakeasy, you'll need the following:

* A [Mintlify documentation repository](/quickstart#creating-the-repository).
* A Speakeasy-generated SDK with a configured [automated code sample URL](https://www.speakeasy.com/docs/code-samples/automated-code-sample-urls).

## Setting up the integration

To integrate Speakeasy with Mintlify, you must get the API's combined spec public URL from the registry and update your `docs.json` configuration file.

### Get the API's combined spec public URL from the registry

Navigate to your [Speakeasy Dashboard](https://app.speakeasy.com) and open the **API Registry** tab. Open the `*-with-code-samples` entry for the API.

<Frame>
  <img src="https://mintcdn.com/omer-914cc1c6/fcMjNrr23zmS_VHA/images/speakeasy/openapi-registry-and-combined-spec.png?fit=max&auto=format&n=fcMjNrr23zmS_VHA&q=85&s=180306a14dd7778b09264b6ad93e8d87" alt="Screenshot of the Speakeasy API Registry page. The API Registry tab is emphasized with a red square and the number 1 and the entry for the API is emphasized with a red square and the number 2." width="2560" height="1440" data-path="images/speakeasy/openapi-registry-and-combined-spec.png" />
</Frame>

<Note>
  If the entry is not labeled **Combined Spec**, ensure that the API has an [automatic code sample URL](https://www.speakeasy.com/docs/code-samples/automated-code-sample-urls) configured.
</Note>

From the registry entry's page, copy the provided public URL.

<Frame>
  <img src="https://mintcdn.com/omer-914cc1c6/fcMjNrr23zmS_VHA/images/speakeasy/copy-combined-spec-url.png?fit=max&auto=format&n=fcMjNrr23zmS_VHA&q=85&s=b183d321f0f2658f0f37ff31a0c805da" alt="Screenshot showing the combined spec registry entry with the copy URL function emphasized with a red square." width="2560" height="1440" data-path="images/speakeasy/copy-combined-spec-url.png" />
</Frame>

### Update your `docs.json` configuration file

Add the combined spec URL to an **Anchors** or **Tabs** section in your `docs.json` file.

Add the combined spec URL to an anchor by updating the `anchor` field in your `docs.json` file as follows:

```json docs.json theme={null}
{
  "anchors": [
    {
      "name": "API Reference",
      // !mark
      "openapi": "SPEAKEASY_COMBINED_SPEC_URL",
      "url": "api-reference",
      "icon": "square-terminal"
    }
  ]
}
```

Add the combined spec URL to a tab by updating the `tab` field in the `docs.json` file as follows:

```json docs.json theme={null}
{
  "tabs": [
    {
      "name": "API Reference",
      "url": "api-reference",
      // !mark
      "openapi": "SPEAKEASY_COMBINED_SPEC_URL"
    }
  ]
}
```

Speakeasy-generated code snippets can now be viewed in your API docs and interacted with in the playground.