Skip to Content
DocumentationIntegrationsIntegrate Speakeasy with Mintlify

Integrate Speakeasy with Mintlify


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

docs.myapi.com
Speakeasy code snippets with Mintlify.

Prerequisites

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

Setting up the integration

Get the API’s combined spec public URL from the registry

Navigate to the Speakeasy Dashboard  and open the API Registry tab. Open the *-with-code-samples entry for the API.

app.speakeasy.com
Screenshot showing the Speakeasy API Registry page

NOTE: If the entry is not labeled Combined Spec, ensure that the API has an automatic code sample URL configured.

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

app.speakeasy.com
Screenshot showing the combined spec registry entry with the share function highlighted.

Update the mint.json configuration file

Add the combined spec URL to Anchors or Tabs in the mint.json file of a Mintlify repository. Anchors are displayed as a list of links on the left side of the documentation, while Tabs are displayed as tabs along the top of the documentation.

Add the combined spec URL to Anchors by updating the anchor field in the mint.json file as follows:

Add the combined spec URL to Tabs by updating the tab field in the mint.json file as follows:

Speakeasy-generated code snippets can now be viewed in the Mintlify API reference documentation. See the code snippets in action in the interactive playground  of the Mintlify-powered documentation site.

Next steps

Mintlify offers flexible customization options for API references generated from OpenAPI documents. For more information, refer to the Mintlify documentation .

Last updated on