ARTICLE DETAIL

资讯详情

深耕编程入门与网站建设的一线实战洞察。

ElevenLabs Agents 平台安装与接入全指南:CLI、JS/Python SDK、REST 与 API Key 配置(OpenMontage 实战)

ElevenLabs Agents 平台安装与接入全指南:CLI、JS/Python SDK、REST 与 API Key 配置(OpenMontage 实战) ElevenLabs Agents 平台安装与接入全指南CLI、JS/Python SDK、REST 与 API Key 配置OpenMontage 实战【免费下载链接】OpenMontageWorlds first open-source, agentic video production system. 12 production pipelines, 100 tools, 700 agent skill and production-knowledge files. Turn your AI coding assistant into a full video production studio.项目地址: https://gitcode.com/GitHub_Trending/op/OpenMontage本文是 ElevenLabs 语音 Agent 生态的落地安装指南。OpenMontage 通过.agents/skills/agents/技能体系把 ElevenLabs Agents 平台实时语音对话 Agent与仓库内的语音生产工具如 elevenlabs_tts接入同一套凭据体系。读完本文你将掌握五种接入形态的完整配置——CLI 命令、JavaScript/TypeScript SDK、Python SDK、cURL/REST以及环境变量的规范姿势并能把它们直接迁移到 OpenMontage 的.env与技能工作流中。适用范围这份安装文档到底管什么被评估的源文档位于 .agents/skills/agents/references/installation.md它隶属于 ElevenLabs Agents 技能.agents/skills/agents/SKILL.md。该技能面向用 ElevenLabs 构建语音 AI Agent语音客服、交互式语音角色、实时语音对话体验而installation.md是它的第一道关卡——环境就绪。从技能头部元数据可以看出这项技能的硬性前提compatibility: Requires internet access and an ElevenLabs API key (ELEVENLABS_API_KEY). metadata: {openclaw: {requires: {env: [ELEVENLABS_API_KEY]}, primaryEnv: ELEVENLABS_API_KEY}}也就是说无论走 CLI、SDK 还是 REST整个接入过程的落点只有一个让系统能够稳定地持有并读取ELEVENLABS_API_KEY。这也和 OpenMontage 主仓库对ELEVENLABS_API_KEY的统一约定完全一致docs/ARCHITECTURE.md 将依赖声明为env:ELEVENLABS_API_KEY对应elevenlabs_tts、music_gen两个工具。CLI 安装官方推荐的管理方式ElevenLabs CLI 是创建和管理 Agent 的首选途径支持 npm、pnpm、yarn 三种包管理器任选其一npm install -g elevenlabs/cli # 或 pnpm add -g elevenlabs/cli # 或 yarn global add elevenlabs/cli环境前提需要 Node.js 16.0.0 或更高版本。安装前可用node --version自查。认证管理三件套elevenlabs auth login # 使用 API key 进行认证 elevenlabs auth whoami # 校验当前登录状态 elevenlabs auth logout # 移除已存储的凭据CLI 会把 API key 安全地存储在~/.agents/api_keys.json用户主目录下的.agents目录注意这与仓库内的 .agents 技能目录是两回事——前者是 CLI 的本地凭据存储后者是 OpenMontage 的技能定义仓库。快速创建并上线一个 Agent# 初始化一个新项目 elevenlabs agents init # 从模板创建 Agent elevenlabs agents add My Assistant --template complete # 推送到 ElevenLabs 平台 elevenlabs agents push配套的技能文档补充了可用模板清单complete、minimal、voice-only、text-only、customer-service、assistant见 .agents/skills/agents/SKILL.md以及常用的管理子命令——elevenlabs agents list / status查看状态、elevenlabs agents pull把平台 Agent 导入本地、elevenlabs tools add-webhook / add-client挂接工具。这些后续操作都以本节的 CLI 安装与认证为前提。JavaScript / TypeScript SDK程序化接入与浏览器端集成需要编程访问或在客户端侧做集成时使用官方 JS SDKnpm install elevenlabs/elevenlabs-js重要提示始终使用elevenlabs/elevenlabs-js。旧的elevenlabsnpm 包v1.x已废弃不应再使用。SDK 初始化支持两种凭据注入方式import { ElevenLabsClient } from elevenlabs/elevenlabs-js; // 方式一环境变量推荐 // 先在环境中设置 ELEVENLABS_API_KEY const client new ElevenLabsClient(); // 方式二显式传入 const client new ElevenLabsClient({ apiKey: your-api-key });方式一是仓库内所有工具采用的统一约定下文环境变量规范一节详述好处是代码零密钥、密钥不外泄到版本库。从废弃包迁移如果环境中已安装旧包先卸载再装新包# 卸载废弃包 npm uninstall elevenlabs # 安装当前主包 npm install elevenlabs/elevenlabs-js # 浏览器端/客户端使用还需 npm install elevenlabs/client # 浏览器客户端 npm install elevenlabs/react # React hooks迁移后对应的 import 变化import { ElevenLabsClient } from elevenlabs/elevenlabs-js; import { Conversation } from elevenlabs/client; import { useConversation } from elevenlabs/react;从 SDK 能力上技能文档.agents/skills/agents/SKILL.md展示了一条典型的建 Agent → 起会话链路服务端用client.conversationalAi.agents.create(...)携带conversationConfig创建 Agent 并获得agentId前端再通过Conversation.startSession({ agentId })连接React 场景用useConversation({ onMessage })配合后端签发的signedUrl启动会话。这些都在本节安装与初始化完毕后才可用。Pythonpip 一行接入pip install elevenlabsfrom elevenlabs import ElevenLabs # 方式一环境变量推荐 # 先在环境中设置 ELEVENLABS_API_KEY client ElevenLabs() # 方式二显式传入 client ElevenLabs(api_keyyour-api-key)Python 侧同样遵循环境变量优先原则。技能文档还给出了创建 Agent 的完整负载示例——client.conversational_ai.agents.create(...)配合enable_versioningTrue在conversation_config里声明agent.first_message、agent.language、agent.prompt含llm与temperature以及tts.voice_id。常见可用voice_id包括JBFqnCBsd6RMkjVDRZzbGeorge、EXAVITQu4vr4xnSDxMaLSarah、onwK4e9ZLuTAKqWW03F9Daniel、XB0fDUnXU5powFXDhCwaCharlotte详见 .agents/skills/agents/SKILL.md。cURL / REST API无 SDK 场景下的最小接入先以环境变量方式导出 API keyexport ELEVENLABS_API_KEYyour-api-key所有 REST 请求通过xi-api-key请求头携带密钥。创建 Agent 的最小示例curl -X POST https://api.elevenlabs.io/v1/convai/agents/create \ -H xi-api-key: $ELEVENLABS_API_KEY \ -H Content-Type: application/json \ -d {name: My Agent, conversation_config: {agent: {prompt: {prompt: You are helpful., llm: gemini-2.0-flash}}, tts: {voice_id: JBFqnCBsd6RMkjVDRZzb}}}值得注意的仓库事实是OpenMontage 内部工具对 REST 的调用方式与此完全同构。看 tools/audio/elevenlabs_tts.py 的_generate实现——它向https://api.elevenlabs.io/v1/text-to-speech/{voice_id}发起POST同样携带xi-api-key: api_key请求头并在params中传output_format支持mp3_44100_128、mp3_44100_192、pcm_16000、pcm_24000。也就是说本文的 REST 接入模式不仅适用于 ConvAI Agent也直接适用于仓库内的语音合成工具链。获取 API Key从零到可用的完整流程获取密钥的标准路径在 ElevenLabs 官网注册账号进入个人设置的 API Keys 页面点击Create API Key并命名立即复制并安全存储密钥只在创建时完整展示一次。仓库内提供了自动化引导技能 .agents/skills/setup-api-key/SKILL.md它把上述流程固化成四步工作流值得参考Step 0先检查再引导先看环境中是否已有ELEVENLABS_API_KEY其次检查项目.env是否含ELEVENLABS_API_KEYvalue若找到已有密钥先用GET https://api.elevenlabs.io/v1/user加xi-api-key头做有效性校验——校验通过就跳过整套配置流程Step 1引导创建指引用户前往 API Keys 页面创建密钥并回传Step 2校验并落盘再次用/v1/user校验新密钥成功后将ELEVENLABS_API_KEYthe-api-key写入项目根目录.env已存在同名行则原地替换。这套先探测已有密钥 → 校验 → 回退 .env的幂等策略能有效避免 Agent 每次重复要求用户输入密钥。环境变量规范唯一必需的密钥变量说明ELEVENLABS_API_KEY你的 ElevenLabs API key必需OpenMontage 中的实际消费链路密钥配置成功后仓库内存在两条明确的消费路径加载层lib/env_loader.py 的load_env()通过dotenv从项目根目录加载.envget_env()/require_env()提供类型化读取。README 的示例.env中对应条目为ELEVENLABS_API_KEYyour-key # Premium TTS, AI music, sound effects见 README.md工具层tools/audio/elevenlabs_tts.py 的get_status()直接检查os.environ.get(ELEVENLABS_API_KEY)来决定工具是否AVAILABLEexecute()第 147-160 行在缺失密钥时立即返回错误并附上安装指引文案——其install_instructions字段第 36-42 行写的正是export ELEVENLABS_API_KEYyour_key_here。docs/PROVIDERS.md的 ElevenLabs 章节docs/PROVIDERS.md还汇总了该密钥解锁的工具与配额信息解锁elevenlabs_tts、music_gen两个工具免费档含 10,000 字符/月与 API 访问权限适合验证类工作。OpenMontage 的 QA 计划中test_01_tts.py、test_03_music.py正是以ELEVENLABS_API_KEY为前置依赖执行带真实成本的冒烟测试见 tests/qa/QA_PLAN.md。环境就绪后的纵深用法Agent 配置与错误处理安装与认证完成后建议顺序阅读同目录下的能力文档它们共同构成 ElevenLabs 技能的可运行闭环.agents/skills/agents/references/agent-configuration.mdconversation_config全字段参考涵盖agent、tts、asr、turn、conversation、vad、language_presets与platform_settings的 CRUD 示例.agents/skills/agents/references/client-tools.mdwebhook、client、system 三类工具扩展.agents/skills/agents/references/widget-embedding.mdelevenlabs-convai agent-id...网页内嵌.agents/skills/agents/references/outbound-calls.md基于 Twilio 的外呼集成。常见错误码速查技能文档.agents/skills/agents/SKILL.md给出了一套排错起点状态码含义处理建议401API key 无效检查ELEVENLABS_API_KEY是否复制完整、是否过期用elevenlabs auth whoami复验404资源不存在核对agent_id、voice_id是否属于当前账号422配置非法对照 agent-configuration 文档校验conversation_config结构与枚举取值429触发限流检查套餐配额等待后重试仓库内的工具实现同样内置了容错策略elevenlabs_tts声明了RetryPolicy(max_retries2, retryable_errors[rate_limit, timeout])并把text、voice_id、stability等字段设为幂等键见 tools/audio/elevenlabs_tts.py若 ElevenLabs 不可用该工具还声明了openai_tts、piper_tts两条回退链避免单一供应商故障阻断整条视频生产流水线。小结一条密钥贯穿三层体系把本文内容放回 OpenMontage 全景中可以看到三层贯通的清晰结构接入层按本文选择 CLI日常管理与上线、JS/Python SDK程序化集成、或 cURL/REST最小验证中的一种或多种完成安装与认证凭据层所有形态最终收敛到ELEVENLABS_API_KEY这一个环境变量——CLI 存入~/.agents/api_keys.json项目侧写入根目录.env由 lib/env_loader.py 统一加载应用层密钥就绪后上层即可调用 ConvAI 平台构建语音 Agent或驱动仓库内的 elevenlabs_tts、music_gen等生产工具完成配音与配乐。建议首次接入按此顺序执行安装 CLI或 pip 安装 Python SDK→ 配置ELEVENLABS_API_KEY到.env→ 用GET /v1/user完成密钥校验 → 参考安装文档中的最小示例跑通第一个 Agent 或第一段 TTS 合成再逐步深入 Agent 配置与工具扩展。【免费下载链接】OpenMontageWorlds first open-source, agentic video production system. 12 production pipelines, 100 tools, 700 agent skill and production-knowledge files. Turn your AI coding assistant into a full video production studio.项目地址: https://gitcode.com/GitHub_Trending/op/OpenMontage创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表