使用模型 API Key
本文介绍如何使用模型服务商提供的 API Key 接入 Midscene,包括完成配置和验证连接。如果你已有 ChatGPT 订阅,也可以参考使用 ChatGPT 订阅 文档中的描述操作。
本页列出的模型配置,本质上都是环境变量。你可以根据使用方式提供这些配置:
使用 Playground 时,在设置页面直接粘贴本页的配置文本。
使用 SDK 或命令行工具时,按照设置环境变量 中的说明加载配置。
如需查询高级配置参数,请阅读模型高级配置与调试 。
支持的模型
模型选型建议和接入方式见模型选择指南 。下面提供各模型的配置示例。
每份配置都需要 Base URL、API Key、模型名称和 MIDSCENE_MODEL_FAMILY。MIDSCENE_MODEL_FAMILY 选择模型适配器,决定坐标处理方式、支持的 API 协议,以及思考和输出参数的发送方式。请使用下方对应模 型列出的 family 值。
豆包 Seed 系列
查看模型配置 环境变量配置示例,以 doubao-seed-2-1-turbo-260628 为例:
MIDSCENE_MODEL_BASE_URL="https://ark.cn-beijing.volces.com/api/v3" # 火山引擎地址
MIDSCENE_MODEL_API_KEY="......"
MIDSCENE_MODEL_NAME="doubao-seed-2-1-turbo-260628"
MIDSCENE_MODEL_FAMILY="doubao-seed"MIDSCENE_LOCATE_MODEL_BASE_URL="https://ark.cn-beijing.volces.com/api/v3" # 火山引擎地址
MIDSCENE_LOCATE_MODEL_API_KEY="......"
MIDSCENE_LOCATE_MODEL_NAME="doubao-seed-2-1-turbo-260628"
MIDSCENE_LOCATE_MODEL_FAMILY="doubao-seed"MIDSCENE_PLANNING_MODEL_BASE_URL="https://ark.cn-beijing.volces.com/api/v3" # 火山引擎地址
MIDSCENE_PLANNING_MODEL_API_KEY="......"
MIDSCENE_PLANNING_MODEL_NAME="doubao-seed-2-1-turbo-260628"
MIDSCENE_PLANNING_MODEL_FAMILY="doubao-seed"MIDSCENE_INSIGHT_MODEL_BASE_URL="https://ark.cn-beijing.volces.com/api/v3" # 火山引擎地址
MIDSCENE_INSIGHT_MODEL_API_KEY="......"
MIDSCENE_INSIGHT_MODEL_NAME="doubao-seed-2-1-turbo-260628"
MIDSCENE_INSIGHT_MODEL_FAMILY="doubao-seed"如果你的火山引擎账号已开通低延迟模式(Fast Tier),可以追加以下请求体参数来使用该能力。通常可将模型响应速度提升约 30% 至 50%。
MIDSCENE_MODEL_EXTRA_BODY_JSON = { "service_tier" : "fast" }
千问 Qwen 系列
查看模型配置 环境变量配置示例,以 qwen3.7-plus 为例:
MIDSCENE_MODEL_BASE_URL="https://dashscope.aliyuncs.com/compatible-mode/v1" # 阿里云地址
MIDSCENE_MODEL_API_KEY="......"
MIDSCENE_MODEL_NAME="qwen3.7-plus"
MIDSCENE_MODEL_FAMILY="qwen3" # 如果你使用了其他版本的 Qwen,需要替换为对应的 model familyMIDSCENE_LOCATE_MODEL_BASE_URL="https://dashscope.aliyuncs.com/compatible-mode/v1" # 阿里云地址
MIDSCENE_LOCATE_MODEL_API_KEY="......"
MIDSCENE_LOCATE_MODEL_NAME="qwen3.7-plus"
MIDSCENE_LOCATE_MODEL_FAMILY="qwen3" # 如果你使用了其他版本的 Qwen,需要替换为对应的 model familyMIDSCENE_PLANNING_MODEL_BASE_URL="https://dashscope.aliyuncs.com/compatible-mode/v1" # 阿里云地址
MIDSCENE_PLANNING_MODEL_API_KEY="......"
MIDSCENE_PLANNING_MODEL_NAME="qwen3.7-plus"
MIDSCENE_PLANNING_MODEL_FAMILY="qwen3" # 如果你使用了其他版本的 Qwen,需要替换为对应的 model familyMIDSCENE_INSIGHT_MODEL_BASE_URL="https://dashscope.aliyuncs.com/compatible-mode/v1" # 阿里云地址
MIDSCENE_INSIGHT_MODEL_API_KEY="......"
MIDSCENE_INSIGHT_MODEL_NAME="qwen3.7-plus"
MIDSCENE_INSIGHT_MODEL_FAMILY="qwen3" # 如果你使用了其他版本的 Qwen,需要替换为对应的 model family
深度求索 DeepSeek 系列
查看模型配置 Midscene 从 v1.12.0 开始支持 DeepSeek。
环境变量配置示例,以 deepseek-flash 为例:
MIDSCENE_MODEL_BASE_URL="https://api.deepseek.com" # DeepSeek API 地址
MIDSCENE_MODEL_API_KEY="......"
MIDSCENE_MODEL_NAME="deepseek-flash"
MIDSCENE_MODEL_FAMILY="deepseek"MIDSCENE_LOCATE_MODEL_BASE_URL="https://api.deepseek.com" # DeepSeek API 地址
MIDSCENE_LOCATE_MODEL_API_KEY="......"
MIDSCENE_LOCATE_MODEL_NAME="deepseek-flash"
MIDSCENE_LOCATE_MODEL_FAMILY="deepseek"MIDSCENE_PLANNING_MODEL_BASE_URL="https://api.deepseek.com" # DeepSeek API 地址
MIDSCENE_PLANNING_MODEL_API_KEY="......"
MIDSCENE_PLANNING_MODEL_NAME="deepseek-flash"
MIDSCENE_PLANNING_MODEL_FAMILY="deepseek"MIDSCENE_INSIGHT_MODEL_BASE_URL="https://api.deepseek.com" # DeepSeek API 地址
MIDSCENE_INSIGHT_MODEL_API_KEY="......"
MIDSCENE_INSIGHT_MODEL_NAME="deepseek-flash"
MIDSCENE_INSIGHT_MODEL_FAMILY="deepseek"
Google Gemini 系列
查看模型配置 环境变量配置示例,以 gemini-3.5-flash 为例:
MIDSCENE_MODEL_BASE_URL="https://generativelanguage.googleapis.com/v1beta/openai/" # Google Gemini API 地址
MIDSCENE_MODEL_API_KEY="......"
MIDSCENE_MODEL_NAME="gemini-3.5-flash"
MIDSCENE_MODEL_FAMILY="gemini"MIDSCENE_LOCATE_MODEL_BASE_URL="https://generativelanguage.googleapis.com/v1beta/openai/" # Google Gemini API 地址
MIDSCENE_LOCATE_MODEL_API_KEY="......"
MIDSCENE_LOCATE_MODEL_NAME="gemini-3.5-flash"
MIDSCENE_LOCATE_MODEL_FAMILY="gemini"MIDSCENE_PLANNING_MODEL_BASE_URL="https://generativelanguage.googleapis.com/v1beta/openai/" # Google Gemini API 地址
MIDSCENE_PLANNING_MODEL_API_KEY="......"
MIDSCENE_PLANNING_MODEL_NAME="gemini-3.5-flash"
MIDSCENE_PLANNING_MODEL_FAMILY="gemini"MIDSCENE_INSIGHT_MODEL_BASE_URL="https://generativelanguage.googleapis.com/v1beta/openai/" # Google Gemini API 地址
MIDSCENE_INSIGHT_MODEL_API_KEY="......"
MIDSCENE_INSIGHT_MODEL_NAME="gemini-3.5-flash"
MIDSCENE_INSIGHT_MODEL_FAMILY="gemini"
OpenAI GPT 系列
查看模型配置 使用 API Key
环境变量配置示例,以 gpt-6-sol 为例:
Chat Responses ? MIDSCENE_MODEL_BASE_URL="https://api.openai.com/v1" # OpenAI API 地址;或你的兼容服务地址
MIDSCENE_MODEL_API_KEY="......"
MIDSCENE_MODEL_NAME="gpt-6-sol"
MIDSCENE_MODEL_FAMILY="gpt-6"MIDSCENE_LOCATE_MODEL_BASE_URL="https://api.openai.com/v1" # OpenAI API 地址;或你的兼容服务地址
MIDSCENE_LOCATE_MODEL_API_KEY="......"
MIDSCENE_LOCATE_MODEL_NAME="gpt-6-sol"
MIDSCENE_LOCATE_MODEL_FAMILY="gpt-6"MIDSCENE_PLANNING_MODEL_BASE_URL="https://api.openai.com/v1" # OpenAI API 地址;或你的兼容服务地址
MIDSCENE_PLANNING_MODEL_API_KEY="......"
MIDSCENE_PLANNING_MODEL_NAME="gpt-6-sol"
MIDSCENE_PLANNING_MODEL_FAMILY="gpt-6"MIDSCENE_INSIGHT_MODEL_BASE_URL="https://api.openai.com/v1" # OpenAI API 地址;或你的兼容服务地址
MIDSCENE_INSIGHT_MODEL_API_KEY="......"
MIDSCENE_INSIGHT_MODEL_NAME="gpt-6-sol"
MIDSCENE_INSIGHT_MODEL_FAMILY="gpt-6"开启 Fast mode(service_tier="fast")
GPT-5.6 Sol 和 GPT-6 Astra 均支持 Fast mode,可以追加 service_tier 请求体参数启用,以 GPT-5.6 Sol 为例:
MIDSCENE_MODEL_NAME = "gpt-5.6-sol"
MIDSCENE_MODEL_FAMILY = "gpt-5"
MIDSCENE_MODEL_EXTRA_BODY_JSON = '{"service_tier":"fast"}' 按照 OpenAI 官方说明,Fast mode 可获得最高 2~2.5 倍的速度,费率为 Standard 费率的两倍。具体速度、价格和使用限制以官方说明 为准。
如需复用 Codex CLI 登录,请参考使用 Codex App Server 。
使用 GPT 时,请注意以下事项:
使用 GPT 做 UI 定位至少需要 GPT-5.4,Midscene 不支持更早的版本。
按照 OpenAI 的文档,GPT-5 在处理非拉丁字母文本、字号太小的文本时效果可能不理想,参见 Images and Vision guide 。
OpenAI 在 computer use 文档中提到,他们观察到 1440x900 和 1600x900 这两种截图尺寸上通常能获得比较好的效果,详见 Computer use guide 。因此,建议按照 OpenAI 的推荐对截图尺寸进行调整。在 Midscene 中,你可以通过 Agent 参数里的 screenshotShrinkFactor 控制截图压缩倍率。如果是浏览器自动化,还可以通过浏览器 viewport 指定页面的尺寸和比例。
使用 Azure OpenAI 的 Chat Completions API 时,"detail": "original" 可能未被正确处理,从而造成点击坐标偏移。遇到此问题时,可以切换到 Responses API。详见 使用 Azure OpenAI 时点击坐标偏移 。
月之暗面 Kimi 系列
查看模型配置 环境变量配置示例,以 kimi-k3 为例:
MIDSCENE_MODEL_BASE_URL="https://api.moonshot.cn/v1" # Moonshot AI API 地址
MIDSCENE_MODEL_API_KEY="......"
MIDSCENE_MODEL_NAME="kimi-k3"
MIDSCENE_MODEL_FAMILY="kimi3" # 如果使用 kimi-k2.6,请改为 "kimi"MIDSCENE_LOCATE_MODEL_BASE_URL="https://api.moonshot.cn/v1" # Moonshot AI API 地址
MIDSCENE_LOCATE_MODEL_API_KEY="......"
MIDSCENE_LOCATE_MODEL_NAME="kimi-k3"
MIDSCENE_LOCATE_MODEL_FAMILY="kimi3" # 如果使用 kimi-k2.6,请改为 "kimi"MIDSCENE_PLANNING_MODEL_BASE_URL="https://api.moonshot.cn/v1" # Moonshot AI API 地址
MIDSCENE_PLANNING_MODEL_API_KEY="......"
MIDSCENE_PLANNING_MODEL_NAME="kimi-k3"
MIDSCENE_PLANNING_MODEL_FAMILY="kimi3" # 如果使用 kimi-k2.6,请改为 "kimi"MIDSCENE_INSIGHT_MODEL_BASE_URL="https://api.moonshot.cn/v1" # Moonshot AI API 地址
MIDSCENE_INSIGHT_MODEL_API_KEY="......"
MIDSCENE_INSIGHT_MODEL_NAME="kimi-k3"
MIDSCENE_INSIGHT_MODEL_FAMILY="kimi3" # 如果使用 kimi-k2.6,请改为 "kimi"
小米 MiMo 系列
查看模型配置 环境变量配置示例,以 mimo-v2.6-pro 为例:
MIDSCENE_MODEL_BASE_URL="https://api.xiaomimimo.com/v1" # 小米 MiMo API 地址
MIDSCENE_MODEL_API_KEY="......"
MIDSCENE_MODEL_NAME="mimo-v2.6-pro"
MIDSCENE_MODEL_FAMILY="xiaomi-mimo"MIDSCENE_LOCATE_MODEL_BASE_URL="https://api.xiaomimimo.com/v1" # 小米 MiMo API 地址
MIDSCENE_LOCATE_MODEL_API_KEY="......"
MIDSCENE_LOCATE_MODEL_NAME="mimo-v2.6-pro"
MIDSCENE_LOCATE_MODEL_FAMILY="xiaomi-mimo"MIDSCENE_PLANNING_MODEL_BASE_URL="https://api.xiaomimimo.com/v1" # 小米 MiMo API 地址
MIDSCENE_PLANNING_MODEL_API_KEY="......"
MIDSCENE_PLANNING_MODEL_NAME="mimo-v2.6-pro"
MIDSCENE_PLANNING_MODEL_FAMILY="xiaomi-mimo"MIDSCENE_INSIGHT_MODEL_BASE_URL="https://api.xiaomimimo.com/v1" # 小米 MiMo API 地址
MIDSCENE_INSIGHT_MODEL_API_KEY="......"
MIDSCENE_INSIGHT_MODEL_NAME="mimo-v2.6-pro"
MIDSCENE_INSIGHT_MODEL_FAMILY="xiaomi-mimo"
智谱 GLM-V 系列
查看模型配置 环境变量配置示例,以 glm-5v-turbo 为例:
MIDSCENE_MODEL_BASE_URL="https://open.bigmodel.cn/api/paas/v4" # BigModel API 地址;Z.AI 使用 https://api.z.ai/api/paas/v4
MIDSCENE_MODEL_API_KEY="......"
MIDSCENE_MODEL_NAME="glm-5v-turbo"
MIDSCENE_MODEL_FAMILY="glm-v"MIDSCENE_LOCATE_MODEL_BASE_URL="https://open.bigmodel.cn/api/paas/v4" # BigModel API 地址;Z.AI 使用 https://api.z.ai/api/paas/v4
MIDSCENE_LOCATE_MODEL_API_KEY="......"
MIDSCENE_LOCATE_MODEL_NAME="glm-5v-turbo"
MIDSCENE_LOCATE_MODEL_FAMILY="glm-v"MIDSCENE_PLANNING_MODEL_BASE_URL="https://open.bigmodel.cn/api/paas/v4" # BigModel API 地址;Z.AI 使用 https://api.z.ai/api/paas/v4
MIDSCENE_PLANNING_MODEL_API_KEY="......"
MIDSCENE_PLANNING_MODEL_NAME="glm-5v-turbo"
MIDSCENE_PLANNING_MODEL_FAMILY="glm-v"MIDSCENE_INSIGHT_MODEL_BASE_URL="https://open.bigmodel.cn/api/paas/v4" # BigModel API 地址;Z.AI 使用 https://api.z.ai/api/paas/v4
MIDSCENE_INSIGHT_MODEL_API_KEY="......"
MIDSCENE_INSIGHT_MODEL_NAME="glm-5v-turbo"
MIDSCENE_INSIGHT_MODEL_FAMILY="glm-v"了解更多关于 GLM-4.6V 开源模型
Jev(实验性)
查看模型配置 Jev 是一个做选择的模型,可以用它选择下一步动作、定位界面元素,以及判断条件是否成立。它的优势是速度快、成本低,但不适用于需要复杂推理的任务。
Midscene 对 Jev 的支持是实验性的。
先配置并保留一个通用模型的默认配置(MIDSCENE_MODEL_*),再追加下面的 Jev 配置。 Jev 用于 Planning、Locate 和 Insight,无法处理的任务仍由通用默认模型完成。默认模型的配置方式参见多模型组合 。
复制以下配置,将 Planning、Locate 和 Insight 配置为 Jev:
# Planning
MIDSCENE_PLANNING_MODEL_BASE_URL="https://api.typesafe.ai/v1" # TypeSafe 官方 API 地址
MIDSCENE_PLANNING_MODEL_API_KEY="......"
MIDSCENE_PLANNING_MODEL_NAME="jev-1.14.0"
MIDSCENE_PLANNING_MODEL_FAMILY="jev"
# Locate
MIDSCENE_LOCATE_MODEL_BASE_URL="https://api.typesafe.ai/v1" # TypeSafe 官方 API 地址
MIDSCENE_LOCATE_MODEL_API_KEY="......"
MIDSCENE_LOCATE_MODEL_NAME="jev-1.14.0"
MIDSCENE_LOCATE_MODEL_FAMILY="jev"
# Insight
MIDSCENE_INSIGHT_MODEL_BASE_URL="https://api.typesafe.ai/v1" # TypeSafe 官方 API 地址
MIDSCENE_INSIGHT_MODEL_API_KEY="......"
MIDSCENE_INSIGHT_MODEL_NAME="jev-1.14.0"
MIDSCENE_INSIGHT_MODEL_FAMILY="jev"Jev 使用 TypeSafe 的 System One 协议,不使用 OpenAI 协议。OpenAI 的部分模型配置不适用于 Jev,包括温度、原生思考、响应格式和流式输出等。
图像输入限制
Jev 要求输入图像的最长边不超过 1568 像素,因此 Midscene 会对超出限制的图像进行等比缩放,并在定位后将结果映射回原图坐标。不足 280 像素的边会补白。该图像处理逻辑后续可能调整。
设置环境变量
Midscene 从环境变量读取模型配置。请选择与你的使用方式对应的方法,也可以沿用项目已有的环境变量管理方式。
在当前 Shell 中设置环境变量
以下示例适用于 Bash 和 Zsh。变量只在当前 Shell 会话及其启动的子进程中有效。
# 将全部值替换为所选模型服务商提供的配置
export MIDSCENE_MODEL_BASE_URL = "https://替换为你的模型服务地址/v1"
export MIDSCENE_MODEL_API_KEY = "替换为你的 API Key"
export MIDSCENE_MODEL_NAME = "替换为你的模型名称"
export MIDSCENE_MODEL_FAMILY = "替换为你的模型对应的 family"
通过 .env 文件配置
Midscene Test(@midscene/test)和旧版 YAML 脚本运行器 (@midscene/cli)会自动读取 .env 文件中的配置。
使用 Midscene Test 时,在生成的测试项目目录中将 .env.example 复制为 .env,填入模型配置后运行 pnpm test,详见创建与使用测试项目 。使用旧版 YAML 脚本运行器时,在运行 midscene 命令的目录中创建 .env。
.env 文件内容示例:
# 将全部值替换为所选模型服务商提供的配置
MIDSCENE_MODEL_BASE_URL = "https://替换为你的模型服务地址/v1"
MIDSCENE_MODEL_API_KEY = "替换为你的 API Key"
MIDSCENE_MODEL_NAME = "替换为你的模型名称"
MIDSCENE_MODEL_FAMILY = "替换为你的模型对应的 family"
.env 中的每一行都不需要添加 export。使用旧版 YAML 脚本运行器时,当前 Shell 中已有的同名变量默认优先于 .env;可通过 --dotenv-override 让文件中的值优先。
JavaScript SDK
Midscene SDK 从 process.env 读取模型配置。编写测试脚本时,可以在自己的测试项目中安装 dotenv ,将模型配置放入项目根目录的 .env 文件,并在脚本入口添加 import 'dotenv/config',然后从项目根目录运行脚本。请在创建 Agent 前加载配置。
其他兼容模型
以下小参数模型也与 Midscene 兼容,主要面向自动化场景。它们对部署硬件的要求较低,但处理复杂任务或大尺寸截图的能力可能受限。选择前,请结合实际任务和部署条件进行评估。
智谱 AutoGLM 系列
查看模型配置 智谱 AutoGLM 是智谱 AI 推出的开源移动端 UI 自动化模型,模型尺寸为 9B。
从 Z.AI(国际) 或 BigModel(国内) 获取 API Key 后,可以使用以下配置:
MIDSCENE_MODEL_BASE_URL = "https://open.bigmodel.cn/api/paas/v4" # 或 https://api.z.ai/api/paas/v4
MIDSCENE_MODEL_API_KEY = "......"
MIDSCENE_MODEL_NAME = "autoglm-phone" # 模型名以平台实际模型名为准
MIDSCENE_MODEL_FAMILY = "auto-glm" # 或 "auto-glm-multilingual" 关于 MIDSCENE_MODEL_FAMILY 配置
AutoGLM 提供了两个版本的模型,通过 MIDSCENE_MODEL_FAMILY 区分:
auto-glm - 对应 AutoGLM-Phone-9B,针对中文环境 优化
auto-glm-multilingual - 对应 AutoGLM-Phone-9B-Multilingual,支持英语等其他语言 场景
请根据你的应用语言选择合适的版本。
Info
AutoGLM 更适合移动端交互。aiAssert 和 aiQuery 等 API 需要理解页面。使用这些 API 时,请通过 MIDSCENE_INSIGHT_MODEL_... 环境变量配置独立的 Insight 模型。详情请参考模型选择指南 。
了解更多关于智谱 AutoGLM
UI-TARS 系列
查看模型配置 你可以在 火山引擎 上使用已部署的 doubao-1.5-ui-tars。
MIDSCENE_MODEL_BASE_URL = "https://ark.cn-beijing.volces.com/api/v3"
MIDSCENE_MODEL_API_KEY = "...."
MIDSCENE_MODEL_NAME = "ep-2025..." # 来自火山引擎的推理接入点 ID 或模型名称
MIDSCENE_MODEL_FAMILY = "vlm-ui-tars-doubao-1.5" 关于 MIDSCENE_MODEL_FAMILY 配置
MIDSCENE_MODEL_FAMILY 用于指定 UI-TARS 版本,使用以下值之一:
vlm-ui-tars:用于模型版本 1.0
vlm-ui-tars-doubao:用于在火山引擎上部署的模型版本 1.5(与 vlm-ui-tars-doubao-1.5 等效)
vlm-ui-tars-doubao-1.5:用于在火山引擎上部署的模型版本 1.5
Info
旧版本使用 MIDSCENE_USE_VLM_UI_TARS=DOUBAO 或 MIDSCENE_USE_VLM_UI_TARS=1.5 配置,该配置仍然兼容但已废弃,建议迁移到 MIDSCENE_MODEL_FAMILY。
迁移对应关系:
MIDSCENE_USE_VLM_UI_TARS=1.0 → MIDSCENE_MODEL_FAMILY="vlm-ui-tars"
MIDSCENE_USE_VLM_UI_TARS=1.5 → MIDSCENE_MODEL_FAMILY="vlm-ui-tars-doubao-1.5"
MIDSCENE_USE_VLM_UI_TARS=DOUBAO → MIDSCENE_MODEL_FAMILY="vlm-ui-tars-doubao"
下一步
验证模型连接 — 检查已配置的模型能否在 Midscene 中正常使用。
按意图配置模型 — 为规划、定位或页面理解配置专用模型,并查看可展开的配置示例。
常见配置错误 — 排查模型家族、API 地址或模型名称错误。
模型结果不可靠时 — 排查操作错误、目标遗漏或页面理解偏差。