> This is a page from the ElevenLabs documentation. For a complete page index, fetch https://elevenlabs.io/docs/llms.txt. For the full documentation in a single file, fetch https://elevenlabs.io/docs/llms-full.txt.

# ElevenAPI 快速入门

完成本指南后，你将在项目中完成 ElevenLabs 设置，并能发起首次文本转语音请求。有两种方式：让编程智能体完成设置，或手动设置。

如需了解其他功能的指南，例如流式传输、语音克隆、语音转文本，请查看 [教程](/docs/zh/eleven-api/guides/cookbooks)部分。

## 使用编程智能体设置

开始前无需账户或 API 密钥。将以下内容粘贴到编程智能体中：

```text
Add ElevenLabs to my project: run `npx -y @elevenlabs/cli@latest onboard init` and follow what it prints.
```

之后 ElevenLabs CLI 会继续操作，并将每一步告知智能体。浏览器会打开一次，以便你登录或创建账户并点击 **授权**。密钥会保存到项目的 env 文件（`.env.local`，Python 项目中为 `.env`），不会提交到 git，也绝不会显示在聊天中。接着，智能体会询问你想构建什么，安装 SDK，将代码添加到应用，并询问是否发送测试请求。

> **Note**
>
> 如果智能体运行在浏览器无法访问的位置，例如通过 SSH 连接的远程机器或
> 云端沙盒，CLI 会要求你自行[创建密钥](https://elevenlabs.io/app/api/api-keys?quickstart=true)，并将其粘贴到 env
> 文件中，然后继续。该命令需要 [Node.js](https://nodejs.org) 才能使用 `npx`。如果没有 Node.js，
> 可通过 Homebrew（macOS 和 Linux）或 Scoop（Windows）[安装 ElevenLabs CLI](https://github.com/elevenlabs/cli#installation)，
> 如果已安装，则进行更新（`brew upgrade elevenlabs`、
> `scoop update elevenlabs`），然后让智能体改为运行 `elevenlabs onboard init`。

## 手动设置

#### 创建 API 密钥

[在控制台中创建 API 密钥](https://elevenlabs.io/app/api/api-keys)，用于安全地[访问 API](/docs/zh/api-reference/authentication)。

将密钥作为受管理的机密信息存储，并根据偏好，通过 `.env` 文件将其作为环境变量传递给 SDK，或直接写入应用配置。

**`.env`**

```js title=".env"
ELEVENLABS_API_KEY=<your_api_key_here>
```

#### 安装 SDK

#### SDK

我们还会使用 `dotenv` 库从环境变量加载 API 密钥。

```python
pip install elevenlabs
pip install python-dotenv
```

```typescript
npm install @elevenlabs/elevenlabs-js
npm install dotenv
```

#### CLI

安装 ElevenLabs CLI。推荐使用 Homebrew（macOS）和 Scoop（Windows）。

**`Homebrew（macOS）`**

```bash title="Homebrew（macOS）"
brew install elevenlabs/tap/elevenlabs
```

**`Scoop（Windows）`**

```powershell title="Scoop（Windows）"
scoop bucket add elevenlabs https://github.com/elevenlabs/scoop-bucket
scoop install elevenlabs
```

**`npm`**

```bash title="npm"
npm install -g @elevenlabs/cli
```

**`curl`**

```bash title="curl"
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/elevenlabs/cli/releases/latest/download/elevenlabs-cli-installer.sh | sh
```

> **Tip**
>
> 正在使用 AI 编程助手？在项目中运行 `elevenlabs generate-skills`，即可将每个命令组的
> `SKILL.md` 写入 `skills/`，无需粘贴文档，助手就能了解 CLI 的完整功能。使用 `--output-dir`
> 可将其放到其他位置。该命令会读取 CLI 内置的 API 定义，因此无需 API 密钥且可离线运行——还能始终与已安装的 CLI 版本保持同步。

然后进行身份验证——这会打开浏览器以授权 CLI：

```bash
elevenlabs auth login
```

> **Note**
>
> 如需通过扬声器播放音频，系统可能会提示你安装 [MPV](https://mpv.io/)
> 和/或 [ffmpeg](https://ffmpeg.org/)。

#### 发起首次请求

#### SDK

根据所选语言，新建名为 `example.py` 或 `example.mts` 的文件，并添加以下代码：

```python
from dotenv import load_dotenv
from elevenlabs.client import ElevenLabs
from elevenlabs.play import play
import os

load_dotenv()

elevenlabs = ElevenLabs(
  api_key=os.getenv("ELEVENLABS_API_KEY"),
)

audio = elevenlabs.text_to_speech.convert(
    text="The first move is what sets everything in motion.",
    voice_id="JBFqnCBsd6RMkjVDRZzb",  # "George" - browse voices at elevenlabs.io/app/voice-library
    model_id="eleven_v4",
    output_format="mp3_44100_128",
)

play(audio)

```

```typescript
import { ElevenLabsClient, play } from "@elevenlabs/elevenlabs-js";
import "dotenv/config";

const elevenlabs = new ElevenLabsClient();
const audio = await elevenlabs.textToSpeech.convert(
	"JBFqnCBsd6RMkjVDRZzb", // "George" - browse voices at elevenlabs.io/app/voice-library
	{
		text: "The first move is what sets everything in motion.",
		modelId: "eleven_v4",
		outputFormat: "mp3_44100_128",
	},
);

await play(audio);

```

然后运行：

```python
python example.py
```

```typescript
npx tsx example.mts
```

应能听到音频通过扬声器播放。

#### CLI

生成语音并保存为 MP3 文件：

```bash
elevenlabs text-to-speech convert \
  --voice-id JBFqnCBsd6RMkjVDRZzb \
  --model-id eleven_v4 \
  --text "The first move is what sets everything in motion." \
  --output-format mp3_44100_128 \
  --output audio.mp3
```

打开 `audio.mp3` 即可收听结果。

## 后续步骤

#### [流式传输音频](/docs/zh/eleven-api/guides/how-to/text-to-speech/streaming)

在生成时流式传输音频，无需等待完整文件，以降低延迟

#### [浏览音色](https://elevenlabs.io/app/voice-library)

探索超过 10,000 个音色，并将示例音色 ID 替换为适合用例的音色

#### [克隆音色](/docs/zh/eleven-api/guides/how-to/voices/instant-voice-cloning)

通过一段简短录音创建自定义音色