Our documentation is hosted at https://elevenlabs.io/docs and all of the content lives inside the fern/ folder.
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 format
We support the following SDKs which can be used to interact with the ElevenLabs platform:
This repository contains your Fern Configuration:
- Deploy the backend with the updated OpenAPI spec
- Update openapi.json in this repo with the new OpenAPI spec (
pnpm run openapi:latest) - (Optional but recommended) Run
fern checkto validate the API andfern generate --group python-sdk --previewto create the generated intermediate step locally - (Optional) Test the changes locally by running
fern generate --group python-sdk --previewand inspecting the generated folder - Add in appropriate overrides to the
openapi-overrides.ymldoc, and repeat steps 3 and 4 until it's correct - Trigger the Python and Typescript Github Actions. To do this, go to the
Actionstab and clickRelease TypeScript SDKorRelease 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 - Review and merge the PRs into the elevenlabs-python or elevenlabs-js repos.
- Create a release tag on both the Python and Typescript repos to release them
To validate your API, run:
pnpm install
pnpm run fern:checkTo view the changes locally run
fern generate --group python-sdk --preview
# `fern write-definition` shows you the intermediate step