ElevenLabs DX

This repo contains the source for the ElevenLabs documentation site, the Next.js example app and the SDK generation.

The autogenerated content (docs and SDK) all live inside the fern folder.

Contributing

We welcome contributions to the ElevenLabs documentation, but ask that you first read through the style guide before submitting pull requests.

Running the docs

The Fern CLI is what builds the documentation.

Install pnpm

npm install -g pnpm

Install the dependencies

pnpm install

Run the following command at the root of the folder

pnpm run dev

Run the following command to lint/format the project

pnpm run fmt

Other developer resources

SDKs

We support the following SDKs which can be used to interact with the ElevenLabs platform:

• Python
• Typescript

SDK generation

While this public repo contains the source for generating ElevenLabs SDKs, only ElevenLabs employees can trigger a regeneration.

The SDK generation is based on two specs and a configuration file:

• OpenAPI spec
• AsyncAPI spec
• Generators config

How to update the SDKs

1. Deploy the backend with the updated OpenAPI spec
2. Update openapi.json in this repo with the new OpenAPI spec (pnpm run openapi:latest)
3. (Optional but recommended) Run fern check to validate the API and fern generate --group python-sdk --preview to create the generated intermediate step locally
4. (Optional) Test the changes locally by running fern generate --group python-sdk --preview and inspecting the generated folder
5. Add in appropriate overrides to the openapi-overrides.yml doc, and repeat steps 3 and 4 until it's correct
6. Trigger the Python and Typescript Github Actions. To do this, go to the Actions tab and click Release TypeScript SDK or Release Python SDK. Enter in the appropriate version number e.g. 1.1.1 (bumped from what's currently released). This will create PRs into the elevenlabs-python or elevenlabs-js repos. Note: Only ElevenLabs employees can trigger these actions.
7. Review and merge the PRs into the elevenlabs-python or elevenlabs-js repos.
8. Create a release tag on both the Python and Typescript repos to release them.

Validating your API Definition

To validate your API, run:

pnpm install
pnpm run fern:check

To view the changes locally run

fern generate --group python-sdk --preview
# `fern write-definition` shows you the intermediate step