CLOUDBRIDGE FOR DEVELOPERS
让数字员工,进入你的业务系统。
通过统一 API 发起工作,让数字员工调用已授权能力完成任务,再以文本、结构化数据、文件或 Webhook 把成果交回你的系统。
const run = await cloudbridge.agents.run({
agent: "sales-analyst",
input: "生成本月销售复盘",
output: ["summary", "metrics", "file"]
});

CLOUDBRIDGE FOR DEVELOPERS
通过统一 API 发起工作,让数字员工调用已授权能力完成任务,再以文本、结构化数据、文件或 Webhook 把成果交回你的系统。
const run = await cloudbridge.agents.run({
agent: "sales-analyst",
input: "生成本月销售复盘",
output: ["summary", "metrics", "file"]
});
CHOOSE YOUR PATH
开发接口与产品操作说明都保留在同一中心,但不需要从头阅读。选择当前目标即可进入对应章节。
个人资料、安全设置和第三方登录属于账户功能。只有通过程序调用数字员工时才需要 API Key,普通工作台对话不需要创建密钥。登录后进入“开发与集成 → API 凭证”创建、设置权限、查看使用次数或撤销密钥。
Authorization: Bearer cbk_your_api_key
DIGITAL EMPLOYEE STUDIO
数字员工工作室覆盖从创建、配置和学习到评测、发布与交付的完整流程。每个环节都有独立操作指南,后续新增的使用技巧也会继续归入这个栏目。
工作台用于创建数字员工、选择当前员工,并通过真实对话验证效果。建议先完成名称、头像和模型设置,再逐步增加人格、Skill、知识库与工具,方便判断每次修改带来的变化。
数字员工任务由服务器保存并交给 Worker 执行,不依赖当前浏览器页面持续打开。发送任务后可以切换员工、进入其他页面或关闭浏览器;任务不会因为离开聊天页而中断,完成结果仍归属原员工和原会话。
定时任务用于让数字员工在指定时间自动工作。调度由主站 API 持续触发,实际任务进入与普通对话相同的 Worker 队列,因此不需要浏览器保持打开。入口位于会员中心侧栏“知识库”之后的“定时任务”。
| 计划类型 | 适合场景 | 时间设置 |
|---|---|---|
| 每隔一段时间 | 轮询数据、持续检查 | 按小时输入,支持由会员等级规定的分钟级最短间隔 |
| 每天 | 日报、每日提醒 | 选择当地时间的小时和分钟 |
| 每周 | 周报、例会准备 | 选择星期、小时和分钟 |
| 每月 | 月报、结算检查 | 选择每月 1–28 日及具体时间 |
| 一次 | 预约执行、一次性提醒 | 选择完整日期与时间 |
在员工工作室中可以把文件直接拖入聊天框、粘贴剪贴板文件,或点击附件按钮选择文件。附件先上传到对象存储,再以受控引用交给当前任务;文件正文不会直接塞入 PostgreSQL,也不会自动写入长期记忆或知识库。
数字员工中枢用于管理员工在正式人格与 Skill 之外逐步掌握的内容,包括长期记忆、个人偏好、工作规则、学习建议和 Skill 版本草稿。进入“控制台 → 数字员工 → 数字员工中枢”,或在对话保存成功后的学习提示中点击“查看中枢”。
简体:你要记住:客户问候时先说明自己的正式员工名称。繁体:記一下:回覆前先確認訂單編號。English: Please remember that weekly reports start with risks.日本語:これを覚えて:回答は日本語で行う。| 模式 | 保存行为 | 适合场景 |
|---|---|---|
| 关闭学习 | 不允许新增对话记忆 | 固定流程或严格合规员工 |
| 仅明确要求 | 只有“记住、以后、保存为偏好”等明确请求才保存 | 希望完全由用户控制 |
| 辅助学习 | 明确记忆直接保存,纠正内容可以形成待确认建议 | 日常使用,推荐 |
| 自动学习并审核 | 允许系统积累学习候选,但仍通过中枢审核后生效 | 高频、持续优化的岗位 |
本页是数字员工中枢的行为契约。它说明哪些内容可以被记住、谁可以修改、什么时候会进入任务上下文,以及员工发布后如何保持稳定。产品界面、工作台、API 和后台服务都应遵守这些规则。
| 层级 | 用途 | 默认可见范围 | 生命周期 |
|---|---|---|---|
| 临时记忆 | 当前任务的上下文、用户刚刚提供的约束 | 当前任务 | 任务结束或会话过期后失效 |
| 个人记忆 | 当前使用者的偏好、习惯和工作约定 | 当前使用者 | 直到暂停、删除或到期 |
| 员工记忆 | 所有者确认的岗位规则和稳定工作事实 | 该员工的授权使用者 | 随员工版本或所有者操作变更 |
| 学习候选 | 重复纠正、反馈或新流程形成的待审核建议 | 员工所有者和管理员 | 审核、拒绝或过期前保留 |
| 正式 Skill | 可复用、可测试、可发布的工作流程 | 按版本和授权范围 | 由版本生命周期管理 |
知识库由发布者维护并绑定到员工。使用者只获得授权后的检索能力,不直接看到知识库原文。数据库、HTTP、邮件、日历和其他外部连接属于实际使用者的连接配置,发布者不能读取使用者密钥或业务数据。每次任务加载记忆前,都必须同时检查记忆状态、范围、过期时间、员工授权和当前版本。
| 场景 | 规则 | 接口行为 |
|---|---|---|
| 普通 API 输入 | 不会自动修改员工配置 | 只执行当前授权版本 |
| 明确调用中枢 | 按范围和权限加载有效记忆 | 返回核心结果及记忆使用摘要 |
| 可选模块失败 | 员工身份、权限和基础设置仍可用 | 返回 partial: true、unavailable 和模块诊断,不用 HTTP 500 代替整个中枢 |
| 核心模块失败 | 无法确认员工或授权边界 | 返回明确错误码,阻止任务执行 |
记忆触发与规则说明支持简体中文、繁体中文、英语和日语。语言变化不改变权限和安全边界。
简体:你要记住:周报先写风险,再写下一步。繁体:記一下:回覆前先確認訂單編號。English: Please remember that weekly reports start with risks.日本語:これを覚えて:回答は日本語で行う。人格决定数字员工如何理解身份、目标、语气和行为边界。名称是正式身份,人格是执行规则;不要只把员工名称重复写进提示词。
Skill 是可复用的任务说明,适合固定流程,例如整理会议纪要、检查合同字段或生成周报。写清触发条件、处理步骤、输出格式和异常处理,比堆叠背景介绍更有效。
知识库用于保存产品手册、制度、FAQ 等固定资料。文档导入后会经过解析和索引;只有绑定到当前员工的知识库才会参与检索。
能力让数字员工在需要时执行搜索、读取网页、查询数据库或调用外部系统。启用需要连接的工具时会打开配置弹窗;未启用的工具不会在运行时获得调用权限。
| 类型 | 配置归属 | 示例 |
|---|---|---|
| 平台能力 | 通常无需客户密钥 | 当前时间、基础网页读取、地图 |
| 个人连接 | 由当前使用者配置 | 数据库、邮件、日历、HTTP API、MCP |
| 发布者固定能力 | 随员工版本发布 | Skill、知识库和输出规则 |
地图是数字员工可直接启用的平台能力,不需要新增后台管理页面。默认使用 OpenStreetMap、Nominatim、Overpass、OSRM 和时区公开服务,支持地点搜索、附近地点、地址解析、反向解析、路线、距离矩阵、时区和静态地图。公开服务不可用时,系统会返回清晰的失败原因,不会把密钥错误当作成功。
| 动作 | 输入示例 | 返回内容 |
|---|---|---|
| 地点与地址 | search_place、geocode、reverse_geocode | 名称、地址、坐标、地点类型 |
| 周边与详情 | nearby_search、place_detail | 地点列表、评分、标签和详情 |
| 路线与距离 | route、distance_matrix | 距离、预计用时、路线摘要 |
| 时区与地图 | timezone、static_map | 时区标识或地图预览地址 |
35.681236,139.767125;系统会在调用 OSRM/Overpass 前转换为其要求的经度,纬度格式。评测不是再次聊天,而是用一组固定用例重复检查当前版本。每条用例至少包括输入、期望结果或评分规则;运行评测集后再决定是否发布新版本。
输入:根据退款政策回答“超过 30 天能否退款?”期望:明确说明不可退款,并引用对应规则;不得编造例外。版本用于固定一次完整配置,包括模型、人格、Skill、知识库、能力和输出规则。发布或审核应引用明确版本,避免开发中的修改影响线上员工。
是否上架数字员工市场和是否开放 API 是两个独立选择。上架前填写类别、实习次数、聘用方式和使用说明并提交审核;审核中及已上架资料会锁定。
输出设置决定调用方可以收到什么,而不只是一段文字。可选择自然对话、结构化数据、报告与文件或混合输出,并设置字段、下载格式与使用权限。
数字员工市场用于发现经过审核的公开员工。可以按名称、岗位类别、热门程度和排行筛选,并在员工档案中查看开发者、员工证、版本、能力说明、实习额度、聘用价格和授权状态。
实习不会把发布者的内部配置复制给你。实习中的员工和已聘员工会显示剩余次数、授权周期、到期时间和员工证;使用入口位于“我的员工”和“员工工作室”。
“我的员工”集中展示自有、实习中和已聘用的数字员工;“工作成果”集中展示运行生成的文件、表格、图片和图表。员工授权与成果文件是两类数据:授权决定能否继续运行,成果则受文件保留和资源库容量规则管理。
会员用于控制数字员工数量、并发任务、定时任务、API 请求频率、最长任务时间、记录保留和队列优先级。会员价格与权益由平台当前配置决定,前台同时显示美元参考价与按固定汇率换算的港币实际付款金额。
充值中心用于购买普通算力并查看支付订单;消费记录按模型、工具、联网、知识检索和资源用量等真实项目归类;员工收益中心仅面向发布了收费数字员工的开发者。
资源库用于保存数字员工可调用的轻量文件、模板、成果和加密连接引用,不是无限网盘。文件内容与员工输出默认存放在对象存储,网页服务器只保存元数据和临时任务状态;每个账户默认总容量为 1024 MB。
| 项目 | 免费规则 | 超出后的计费 |
|---|---|---|
| 账户存储 | 整个账户累计前 5 MB | 超过 5 MB 的部分按 US$0.020923/GB/月计费,即 20.923 算力点/GB/月,按日折算;默认总容量上限 1024 MB。 |
| 上传 | 全部免费 | 不收取上传流量费。 |
| 下载外网流量 | 无免费起步额度 | 0–10 TB:US$0.115385/GB = 115.385 算力点/GB;10–50 TB:US$0.104615/GB = 104.615 算力点/GB;50–150 TB:US$0.100000/GB = 100 算力点/GB;150 TB 以上:US$0.092308/GB = 92.308 算力点/GB。 |
| 读取与写入请求 | 全部免费 | GET、PUT、DELETE、POST、List 等请求只记录用量,不向客户收费。 |
资源费用统一按 1 USD = 1,000 算力点结算,实际扣费以资源库每日结算记录为准。
员工读取知识库、企业资源或绑定文件时会记录读取事件;上传成果、删除文件、更新属性和列举目录会记录写入事件,但这些请求不向客户收费;向用户浏览器或外部系统传输文件时才记录下载外网流量并计费。
DIGITAL EMPLOYEE API
API 面向需要把已授权数字员工接入网站、企业 OA、CRM 或自动化流程的开发者。调用前需要账户 API Key、员工证中的 Agent ID,且目标员工必须已经发布、运行正常并允许 API 访问。
{agentId},自有员工、市场员工和聘用后的员工使用同一个唯一 ID。agent:run 和 run:read。POST /v1/agents/{agentId}/responses 创建异步任务,并保存返回的 Run ID。artifact:read 权限。会员页面中的 API 每分钟请求、最长任务、记录保留和队列优先级均已接入真实运行链路,不是展示字段。API 请求额度按调用时的有效会员等级执行;任务创建时会保存任务时长、记录保留和队列优先级快照,排队期间套餐变化不会改动已创建任务。
429,并通过 Retry-After、X-RateLimit-Limit 和 X-RateLimit-Remaining 告知调用方。最长任务从 Worker 正式领取任务开始计时。到达会员上限后 Worker 会停止等待并上报 membership_task_timeout,主站也会清理未正常回执的超时任务并释放冻结算力。记录保留从任务结束时开始,按会员天数保留对话、输入输出、事件和成果文件;到期后接口返回 410 run_history_expired。消费账单、用量记录和财务审计不会被删除。保留天数为 0 表示长期保留。队列优先级等级越高越早获得空闲 Worker;等待中的任务每 5 分钟获得一次有限的优先补偿,避免普通等级永久排不到。429 按 Retry-After 退避;长任务使用 Webhook 接收结果,不要高频轮询。历史资料需要长期使用时,应在过期前保存到企业资源库。创建异步数字员工任务。平台按费率收取员工基础费、单次最低费用,并叠加模型 Token、工具、联网、知识检索和容器等实际资源用量。发布者获得员工订阅收入,不参与单次运行费用分成。
curl https://ai.cbapi.ai/v1/agents/AGENT_ID/responses \
-H "Authorization: Bearer cbk_your_api_key" \
-H "Idempotency-Key: order-20260813-001" \
-H "Content-Type: application/json" \
-d '{"input":"生成本月销售摘要和 CSV 文件","model":"developer-recommended-model","variables":{"department":"销售部"},"webhookEndpointId":"webhook_uuid"}'| 字段 | 是否必填 | 说明 |
|---|---|---|
input 或 message | 是 | 任务指令,最长 12,000 字符。 |
model | 否 | 指定允许使用的模型;不传时使用员工版本中的开发者推荐模型。 |
variables | 否 | 传递结构化业务变量,不会因此自动修改员工记忆或正式配置。 |
webhookEndpointId | 否 | 必须是当前 API Key 所属账户下已启用的 Webhook 端点。 |
{"id":"run_uuid","object":"agent.run","status":"queued","replayed":false}Idempotency-Key。相同 API Key 下,服务端会返回原任务并标记 replayed: true,不会再次创建任务或冻结算力。读取任务状态、输出、用量和交付次数。任务在服务器端持续执行,与调用方页面是否打开无关;调用方应先判断 status,再处理 output.response.content。
{
"status": "succeeded",
"output": {
"text": "本月销售额增长 18%。",
"response": {
"schemaVersion": "1.0",
"content": [
{"type":"markdown","text":"本月销售额增长 18%。"},
{"type":"json","value":{"growth":18}},
{"type":"file","name":"sales.csv","downloadUrl":"/api/agent-artifacts/.../download"}
],
"validation": {"status":"valid"}
}
}
}queued、running 表示尚未结束,稍后重试或改用 SSE/Webhook。完成succeeded 时读取文本、JSON 和文件内容;下载文件需要 artifact:read 权限。失败failed 时读取 error,并记录 Run ID 供任务中心或客服排查。历史到期超过会员记录保留期后返回 410 run_history_expired,财务与审计记录不受影响。短任务可轮询状态;需要实时进度时使用 SSE;企业系统需要可靠异步交付时,在“开发与集成 → API 凭证”创建 Webhook,并在创建任务时传入端点 ID。
GET /v1/runs/{runId}/events,通过带 Authorization 请求头的 fetch 流式读取。Webhook任务成功或失败后投递,非 2xx 将在 30 秒、2 分钟、10 分钟、1 小时、6 小时、1 天和 2 天后重试。幂等接收使用 Cloudbridge-Event-Id 去重,同一投递重试保持相同事件 ID。const signed = `${timestamp}.${rawRequestBody}`;
const expected = hmacSha256(webhookSecret, signed);
// 与 Cloudbridge-Signature 中的 v1=... 做恒定时间比较同时检查 Cloudbridge-Timestamp 与当前时间差,建议超过 5 分钟拒绝,以降低重放风险。
排查接口问题时,最重要的是保留任务标识和原始响应,而不是反复创建新任务。创建成功后以 Run ID 为主线,可以在状态接口、事件流、Webhook 投递记录和控制台任务中心交叉核对。
Idempotency-Key 和响应状态码;不要记录完整密钥。429 必须遵守 Retry-After。| 错误码 | 含义 | 处理 |
|---|---|---|
invalid_api_key | 密钥无效、已撤销或已过期 | 检查 Bearer 格式,必要时重新创建密钥 |
api_scope_required | API Key 缺少所需权限 | 按 requiredScope 更新或重新创建密钥 |
agent_not_found | 员工不存在、未发布、停用或未开启 API | 核对 Agent ID 和发布与访问设置 |
api_access_denied | 没有数字员工调用权限 | 检查聘用授权、有效期和 API 访问范围 |
input_required / input_too_large | 任务指令为空或超过 12,000 字符 | 补充或拆分任务指令 |
invalid_idempotency_key | 幂等键超过 120 字符 | 使用稳定、短小的业务请求编号 |
invalid_webhook_endpoint | 回调端点不属于当前密钥或已停用 | 在 API 凭证页面重新选择有效端点 |
membership_api_rate_limit_reached | 超过会员每分钟 API 请求额度 | 读取 Retry-After 后重试,或升级会员等级 |
membership_concurrency_limit_reached | 运行中任务达到会员并发上限 | 等待现有任务完成,或升级会员等级 |
membership_task_timeout | 超过会员允许的最长任务时间 | 拆分任务或升级会员等级 |
membership_schedule_limit_reached | 定时任务数量达到会员上限 | 删除不再使用的计划或升级会员 |
membership_schedule_interval_too_short | 执行间隔短于当前会员允许值 | 按响应中的 minimumMinutes 调整 |
invalid_timezone | 时区名称无效 | 使用有效 IANA 时区,如 Asia/Tokyo |
attachment_count_exceeded | 单次任务超过 5 个附件 | 减少附件数量或拆分任务 |
attachment_too_large / attachment_total_size_exceeded | 单文件超过 10 MB 或合计超过 30 MB | 压缩文件或拆分上传 |
attachment_expired / attachment_not_ready | 临时附件已过期或已被其他任务使用 | 重新上传后再发送任务 |
attachment_storage_unavailable | 对象存储暂时不可用 | 稍后重试,附件不会回退写入数据库 |
run_not_found | 任务不存在或不属于当前账户 | 核对 Run ID 和 API Key 所属账户 |
run_history_expired | 任务详情已按保留期限归档 | 从资源库读取已保存成果,或重新运行任务 |
agent_output_api_disabled | 发布版本禁止 API 输出 | 联系发布者或改用员工工作室 |
agent_artifact_expired | 任务成果已过期 | 从资源库读取副本或重新运行任务 |
Idempotency-Key;查询和下载可使用指数退避。持续失败时保留 Run ID、时间和错误码后联系支持。