开发者中心
接口文档API 参考

CLOUDBRIDGE FOR DEVELOPERS

让数字员工,进入你的业务系统。

通过统一 API 发起工作,让数字员工调用已授权能力完成任务,再以文本、结构化数据、文件或 Webhook 把成果交回你的系统。

Bearer API Key幂等请求按真实用量计费
agent-run.jsLIVE
const run = await cloudbridge.agents.run({
  agent: "sales-analyst",
  input: "生成本月销售复盘",
  output: ["summary", "metrics", "file"]
});
任务已完成3 项成果已交付
MD销售复盘.mdJSON核心指标CSVsales.csv
1发起任务API 创建运行2员工执行模型与工具协作3接收进度轮询或 SSE4交付成果响应、文件或回调
01 / RUN创建数字员工任务从网站、OA、CRM 或自动化流程发起真实工作。查看请求格式 → 02 / EVENTS获取实时状态通过轮询或 SSE 展示排队、执行和完成状态。查看事件流 → 03 / WEBHOOK可靠异步回调任务结束后签名投递,并支持失败自动重试。查看签名规则 → 04 / OUTPUT接收多种成果统一处理 Markdown、JSON、表格、图表与下载文件。查看输出结构 →
接入导航

CHOOSE YOUR PATH

从你要完成的事情开始

开发接口与产品操作说明都保留在同一中心,但不需要从头阅读。选择当前目标即可进入对应章节。

账户

账户与 API Key

个人资料、安全设置和第三方登录属于账户功能。只有通过程序调用数字员工时才需要 API Key,普通工作台对话不需要创建密钥。登录后进入“开发与集成 → API 凭证”创建、设置权限、查看使用次数或撤销密钥。

密钥安全API Key 只在创建时完整显示。不要把密钥写进前端网页、公开仓库或分享给其他人。
Authorization: Bearer cbk_your_api_key
大型栏目

DIGITAL EMPLOYEE STUDIO

数字员工工作室

数字员工工作室覆盖从创建、配置和学习到评测、发布与交付的完整流程。每个环节都有独立操作指南,后续新增的使用技巧也会继续归入这个栏目。

1创建→2配置→3测试→4评测→5发布
数字员工工作室 · 01

工作台与创建

工作台用于创建数字员工、选择当前员工,并通过真实对话验证效果。建议先完成名称、头像和模型设置,再逐步增加人格、Skill、知识库与工具,方便判断每次修改带来的变化。

  1. 1点击“新建员工”,填写名称和用途。
  2. 2在基本设置选择当前模型并保存。
  3. 3发送几条典型任务,确认基础回答正常。
  4. 4再加入人格、知识和能力,逐项测试。
技巧一次只调整一类配置,更容易定位效果变好或变差的原因。
运行与自动化 · 01

后台任务与任务中心

数字员工任务由服务器保存并交给 Worker 执行,不依赖当前浏览器页面持续打开。发送任务后可以切换员工、进入其他页面或关闭浏览器;任务不会因为离开聊天页而中断,完成结果仍归属原员工和原会话。

离开页面已进入排队或执行状态的任务继续运行,重新打开工作台后可恢复结果。切换员工每个请求都绑定创建时的员工、会话和任务 ID,其他员工不会接收该任务的回复。任务中心统一查看排队、执行中、已完成、失败和已取消任务,并按员工、来源、状态与时间筛选。工作成果任务生成的文件、图片、图表和报告集中进入“工作成果”;需要长期保留的文件应保存到资源库。失败恢复任务失败后会保留失败原因并释放未使用的预扣算力;不要通过重复刷新页面判断任务是否结束。
  1. 1发送任务后确认聊天中出现排队或执行状态。
  2. 2需要离开时直接切换页面,无需保持标签页前台运行。
  3. 3从“任务中心”按员工或任务 ID 找回进度。
  4. 4完成后回到原员工会话查看回答,或在“工作成果”下载文件。

打开任务中心 →

运行与自动化 · 02

定时任务

定时任务用于让数字员工在指定时间自动工作。调度由主站 API 持续触发,实际任务进入与普通对话相同的 Worker 队列,因此不需要浏览器保持打开。入口位于会员中心侧栏“知识库”之后的“定时任务”。

计划类型适合场景时间设置
每隔一段时间轮询数据、持续检查按小时输入,支持由会员等级规定的分钟级最短间隔
每天日报、每日提醒选择当地时间的小时和分钟
每周周报、例会准备选择星期、小时和分钟
每月月报、结算检查选择每月 1–28 日及具体时间
一次预约执行、一次性提醒选择完整日期与时间
时区默认使用账户时区,也可为每个任务单独选择 IANA 时区;选择器支持搜索以及简体中文、繁体中文、英文和日语名称。员工与版本任务绑定创建时选择的员工和版本;员工被归档、停用或失去运行条件时,计划会暂停或失败并保留原因。会员限制可创建数量和最短执行间隔由当前会员权益决定,创建时会进行真实校验。执行记录每次触发都会生成独立任务,可在任务中心查看状态、实际模型、费用和成果。运行控制支持暂停、恢复和立即执行;一次性任务完成后自动结束,周期任务会持续生成独立运行记录。
避免重复工作定时任务的指令应说明数据范围、输出位置和重复执行规则。外部系统还会触发同一业务时,建议在指令或 Skill 中加入日期、订单号等幂等条件。

打开定时任务 →

运行与自动化 · 03

聊天附件

在员工工作室中可以把文件直接拖入聊天框、粘贴剪贴板文件,或点击附件按钮选择文件。附件先上传到对象存储,再以受控引用交给当前任务;文件正文不会直接塞入 PostgreSQL,也不会自动写入长期记忆或知识库。

数量限制每次任务最多 5 个附件。大小限制单个文件最大 10 MB,每次任务附件合计最大 30 MB;账户同时存在的临时附件最多占用 100 MB。临时保留未使用附件默认保留 24 小时;已绑定任务的附件在任务结束并到期后由系统清理。安全隔离附件只能由上传者使用,并只允许领取该任务的 Worker 在执行期间读取;传输时校验文件完整性。长期保存需要反复使用的制度、模板或资料应保存到资源库或知识库;需要长期留存的任务文件应保存为员工成果。
附件不是知识库附件只为当前任务提供临时输入。上传文件不会训练模型,也不会自动改变数字员工的人格、Skill 或长期记忆。
数字员工工作室 · 05

数字员工中枢

数字员工中枢用于管理员工在正式人格与 Skill 之外逐步掌握的内容,包括长期记忆、个人偏好、工作规则、学习建议和 Skill 版本草稿。进入“控制台 → 数字员工 → 数字员工中枢”,或在对话保存成功后的学习提示中点击“查看中枢”。

中枢总览查看生效记忆、待确认学习、正式 Skill 和知识库数量。记忆与偏好新增、暂停、恢复或删除已经确认的内容。学习中心审核重复纠正和 Skill 修改产生的候选建议。Skill 管理查看正式版本;员工所有者可以创建草稿,确认后再激活。知识与资料查看当前员工绑定的知识来源,内容维护仍在知识库页面完成。学习时间线追踪记忆、建议和设置的来源与变更时间。中枢设置选择学习方式、跨会话范围、保留时间和敏感信息过滤。

从对话中让员工记住

  1. 1在正式工作台使用明确表达,例如“你要记住:回复客户前先确认订单号”或“记一下:周报先写风险”。
  2. 2发送后查看聊天区提示。只有出现“已记住”绿色回执,才表示内容已经写入中枢;普通模型回答不代表保存成功。
  3. 3点击回执中的“查看中枢”,在“记忆与偏好”确认内容、类型和生效范围。
  4. 4开启一个新对话,用相同业务场景验证员工是否按已确认内容执行。
支持的明确表达简体:你要记住:客户问候时先说明自己的正式员工名称。繁体:記一下:回覆前先確認訂單編號。English: Please remember that weekly reports start with risks.日本語:これを覚えて:回答は日本語で行う。

学习模式

模式保存行为适合场景
关闭学习不允许新增对话记忆固定流程或严格合规员工
仅明确要求只有“记住、以后、保存为偏好”等明确请求才保存希望完全由用户控制
辅助学习明确记忆直接保存,纠正内容可以形成待确认建议日常使用,推荐
自动学习并审核允许系统积累学习候选,但仍通过中枢审核后生效高频、持续优化的岗位

生效范围与权限

仅对我来自工作台对话的记忆默认只影响当前使用者,不改变其他人的员工体验。全员生效员工所有者可在中枢手动添加全员工作规则;购买者不能修改发布者的正式配置。试用模式体验对话不会形成长期记忆,也不会进入购买者的个人中枢。API 任务外部 API 创建任务不会根据一句普通输入自动修改员工配置;需要在中枢明确维护记忆和规则。
身份与安全边界学习内容不能覆盖员工正式名称、平台安全规则或已发布 Skill。问候模板应使用员工设置中的正式名称;密码、Token、密钥和连接字符串不会被保存为记忆。
没有看到“已记住”检查是否处于试用模式、是否已经开启学习,以及表达是否包含明确的记忆要求。保存失败时聊天区会显示原因,本次对话仍可继续。

打开数字员工中枢 →

数字员工工作室 · 06

数字员工中枢规则与生命周期

本页是数字员工中枢的行为契约。它说明哪些内容可以被记住、谁可以修改、什么时候会进入任务上下文,以及员工发布后如何保持稳定。产品界面、工作台、API 和后台服务都应遵守这些规则。

先记住一个原则普通聊天不会自动改变员工配置;只有明确的记忆请求、经过审核的学习候选或所有者主动保存,才会改变中枢。

一、记忆分层

层级用途默认可见范围生命周期
临时记忆当前任务的上下文、用户刚刚提供的约束当前任务任务结束或会话过期后失效
个人记忆当前使用者的偏好、习惯和工作约定当前使用者直到暂停、删除或到期
员工记忆所有者确认的岗位规则和稳定工作事实该员工的授权使用者随员工版本或所有者操作变更
学习候选重复纠正、反馈或新流程形成的待审核建议员工所有者和管理员审核、拒绝或过期前保留
正式 Skill可复用、可测试、可发布的工作流程按版本和授权范围由版本生命周期管理

二、写入与回执

  1. 1只有“请记住”“记一下”“以后都……”等明确表达,才会触发直接记忆写入;普通纠正默认只作为上下文。
  2. 2系统先做权限、敏感信息和重复内容检查。密码、Token、API Key、私钥、数据库连接串和完整凭据禁止写入。
  3. 3写入成功必须在对话区显示“已写入员工中枢”回执,并标出记忆类型、范围和摘要;没有回执就不能视为保存成功。
  4. 4相同规则再次写入应更新原记录或增加版本,不应无限生成重复记忆。暂停、删除和过期内容不得继续注入任务。

三、学习模式与 Skill 生命周期

关闭学习不从对话产生新的长期记忆或学习候选。仅明确要求明确记忆可保存,重复纠正不会自动进入正式配置。辅助学习明确记忆直接保存,重复纠正形成待审核候选,适合日常使用。自动学习并审核可积累候选,但任何候选都必须经过中枢审核,不能绕过安全规则或所有者确认。Skill 修改上传的标准 Skill 是原始版本;明确要求修改时先生成草稿,所有者确认后才激活。版本保留激活新 Skill 后保留旧版本;已发布员工使用发布快照,开发草稿不能静默改变线上行为。

四、所有权、试用与购买权限

员工所有者可以维护员工记忆、审核学习候选、激活 Skill、绑定知识库并创建发布版本。购买者与试用者只能维护自己的个人记忆和自己的工具连接,不能修改发布者人格、正式 Skill 或知识库原文。试用隔离试用对话不会污染发布者长期记忆,也不会自动写入购买者永久中枢;试用限制按发布者设置的次数或期限执行。发布锁定已提交审核或已上架的公开资料、价格、使用说明和 Skill 必须通过下架、创建新版本和重新审核修改。

五、知识库、连接与调用

知识库由发布者维护并绑定到员工。使用者只获得授权后的检索能力,不直接看到知识库原文。数据库、HTTP、邮件、日历和其他外部连接属于实际使用者的连接配置,发布者不能读取使用者密钥或业务数据。每次任务加载记忆前,都必须同时检查记忆状态、范围、过期时间、员工授权和当前版本。

六、API 契约与部分可用

场景规则接口行为
普通 API 输入不会自动修改员工配置只执行当前授权版本
明确调用中枢按范围和权限加载有效记忆返回核心结果及记忆使用摘要
可选模块失败员工身份、权限和基础设置仍可用返回 partial: true、unavailable 和模块诊断,不用 HTTP 500 代替整个中枢
核心模块失败无法确认员工或授权边界返回明确错误码,阻止任务执行

七、多语言表达

记忆触发与规则说明支持简体中文、繁体中文、英语和日语。语言变化不改变权限和安全边界。

简体:你要记住:周报先写风险,再写下一步。繁体:記一下:回覆前先確認訂單編號。English: Please remember that weekly reports start with risks.日本語:これを覚えて:回答は日本語で行う。

八、故障排查

没有“已写入员工中枢”回执先检查是否处于试用模式、学习模式是否关闭、表达是否为明确记忆请求,以及内容是否包含禁止保存的敏感信息。无回执时不要重复刷新页面,应查看中枢时间线和诊断记录。
显示“部分资料暂时不可用”这表示某个可选模块(例如 memories)读取失败,员工核心设置仍可使用。后台应记录员工 ID、模块名和数据库错误码;用户不需要登录服务器排错。

打开数字员工中枢 →

数字员工工作室 · 07

人格设置

人格决定数字员工如何理解身份、目标、语气和行为边界。名称是正式身份,人格是执行规则;不要只把员工名称重复写进提示词。

角色定位它是谁、服务谁、主要解决什么问题。工作原则必须遵守的步骤、判断标准和禁止事项。表达方式语言、篇幅、格式和专业程度。
数字员工工作室 · 08

Skill 编辑器

Skill 是可复用的任务说明,适合固定流程,例如整理会议纪要、检查合同字段或生成周报。写清触发条件、处理步骤、输出格式和异常处理,比堆叠背景介绍更有效。

技巧一个 Skill 尽量只解决一类任务。删除已被员工使用的 Skill 前,应先解除关联或确认影响。
数字员工工作室 · 09

知识库

知识库用于保存产品手册、制度、FAQ 等固定资料。文档导入后会经过解析和索引;只有绑定到当前员工的知识库才会参与检索。

适合存放稳定、需要引用或需要频繁查询的资料。不适合存放密码、临时指令或需要实时更新的数据。发布后发布者知识随版本使用,购买者看不到知识库原文。
数字员工工作室 · 10

能力与连接

能力让数字员工在需要时执行搜索、读取网页、查询数据库或调用外部系统。启用需要连接的工具时会打开配置弹窗;未启用的工具不会在运行时获得调用权限。

类型配置归属示例
平台能力通常无需客户密钥当前时间、基础网页读取、地图
个人连接由当前使用者配置数据库、邮件、日历、HTTP API、MCP
发布者固定能力随员工版本发布Skill、知识库和输出规则

地图能力包

地图是数字员工可直接启用的平台能力,不需要新增后台管理页面。默认使用 OpenStreetMap、Nominatim、Overpass、OSRM 和时区公开服务,支持地点搜索、附近地点、地址解析、反向解析、路线、距离矩阵、时区和静态地图。公开服务不可用时,系统会返回清晰的失败原因,不会把密钥错误当作成功。

免费默认没有 Google Key 也可以使用基础地图能力;公开服务由平台统一限流和回退。Google 增强需要更丰富的地点、路线或时区数据时,可在“企业资源 → 加密凭据”创建 Google Maps API Key,再把该凭据绑定到员工的地图能力。凭据隔离Key 只在 Worker 运行时短暂注入,不进入聊天记录、记忆、模型上下文、前端响应或普通日志;购买者永远看不到发布者的 Key。发布声明上架资料的使用说明或连接要求中应写明“基础地图无需 Key;Google Maps 为可选增强,费用与配额由凭据所有者承担”。
动作输入示例返回内容
地点与地址search_place、geocode、reverse_geocode名称、地址、坐标、地点类型
周边与详情nearby_search、place_detail地点列表、评分、标签和详情
路线与距离route、distance_matrix距离、预计用时、路线摘要
时区与地图timezone、static_map时区标识或地图预览地址
坐标格式工具参数统一使用“纬度,经度”(latitude,longitude),例如 35.681236,139.767125;系统会在调用 OSRM/Overpass 前转换为其要求的经度,纬度格式。
聘用别人的员工如果员工需要数据库、地图增强或其他外部应用,聘用者仍需配置自己的连接或加密凭据;发布者不能读取聘用者的密钥和业务数据。地图基础能力不因购买而自动获得发布者的 Google Key。
数字员工工作室 · 11

训练与评测

评测不是再次聊天,而是用一组固定用例重复检查当前版本。每条用例至少包括输入、期望结果或评分规则;运行评测集后再决定是否发布新版本。

示例用例输入:根据退款政策回答“超过 30 天能否退款?”期望:明确说明不可退款,并引用对应规则;不得编造例外。
数字员工工作室 · 12

版本管理

版本用于固定一次完整配置,包括模型、人格、Skill、知识库、能力和输出规则。发布或审核应引用明确版本,避免开发中的修改影响线上员工。

保存版本为当前配置建立可追踪快照。版本对比确认两次修改涉及哪些模块。恢复版本以旧版本为基础创建新的工作版本,不覆盖历史。
数字员工工作室 · 13

发布与访问

是否上架数字员工市场和是否开放 API 是两个独立选择。上架前填写类别、实习次数、聘用方式和使用说明并提交审核;审核中及已上架资料会锁定。

  1. 1完成工作台测试和评测。
  2. 2填写市场资料、实习次数和免费或周期价格。
  3. 3提交审核,等待管理员通过或查看拒绝理由。
  4. 4需要改价或修改公开资料时先下架,再重新提交审核。
地图能力声明如果版本启用了地图,请在使用说明或连接要求中说明:基础地图无需 API Key;Google Maps 仅作为可选增强,使用者可以绑定自己的企业加密凭据,凭据费用与配额由凭据所有者承担。不要在公开资料、Skill 或知识库中粘贴 Key。
数字员工工作室 · 14

输出设置

输出设置决定调用方可以收到什么,而不只是一段文字。可选择自然对话、结构化数据、报告与文件或混合输出,并设置字段、下载格式与使用权限。

文本Markdown 和说明
结构化数据JSON 字段与类型校验
表格与指标业务系统可直接解析
图表与文件作为任务产物下载
字段规则“选填 / 必填”表示该字段是否必须出现在结构化结果中,不是让使用者确认一次操作。
使用与资产

数字员工市场

数字员工市场用于发现经过审核的公开员工。可以按名称、岗位类别、热门程度和排行筛选,并在员工档案中查看开发者、员工证、版本、能力说明、实习额度、聘用价格和授权状态。

员工证与 Agent ID每位员工拥有稳定且唯一的 Agent ID;同一员工在市场、聘用后工作台和公开 API 中使用同一个 ID。实习体验按发布者配置的次数体验能力,不会获得发布者知识库原文、密钥或内部配置。正式聘用授权期内可进入员工工作室并运行任务;到期后可从“我的员工”直接续订。模型选择聘用者可以在允许范围内选择运行模型,界面会标明开发者推荐模型;更换模型只影响自己的运行,不会修改发布者版本。连接归属数据库、Google Maps、邮件和其他外部连接由实际使用者绑定自己的加密凭据。
使用与资产

实习与已聘员工

实习不会把发布者的内部配置复制给你。实习中的员工和已聘员工会显示剩余次数、授权周期、到期时间和员工证;使用入口位于“我的员工”和“员工工作室”。

实习按发布者设置的可体验次数扣减,不形成普通长期会话,也不会写入长期记忆。聘用授权期内可运行,模型、工具、联网和知识检索的实际用量仍按账户规则计费。续订授权即将到期或已经到期时,从员工卡片点击“续订”直接选择周期,无需重新寻找市场页面。到期或删除停止创建新任务,但历史任务、订单、账单和审计记录仍按保留规则存在。
使用与资产

员工资产与任务成果

“我的员工”集中展示自有、实习中和已聘用的数字员工;“工作成果”集中展示运行生成的文件、表格、图片和图表。员工授权与成果文件是两类数据:授权决定能否继续运行,成果则受文件保留和资源库容量规则管理。

会员与权益

会员、订阅与赠送算力

会员用于控制数字员工数量、并发任务、定时任务、API 请求频率、最长任务时间、记录保留和队列优先级。会员价格与权益由平台当前配置决定,前台同时显示美元参考价与按固定汇率换算的港币实际付款金额。

月付与年付通过 Stripe 建立自动续费订阅;确认页显示港币实际支付金额,会员中心底部可进入订阅管理,更新付款方式或关闭自动续费。算力分账普通算力来自充值或收益转回,长期保留;会员赠送算力单独显示,运行任务时优先使用,并按发放周期到期。活动加送月付、年付活动只增加每期发放的会员算力,不改变 Stripe 实际订阅价格。活动与兑换码平台可发放体验会员、额外算力或兑换码;领取记录、有效期和剩余额度会出现在会员中心。支付尝试未支付、失败或超过 24 小时的支付会话不会产生会员权益或收入,可从“最近支付尝试”重新发起支付。权益快照任务创建时保存最长运行时间、记录保留和队列优先级等关键限制,排队期间变更会员不会改动已经创建的任务。
赠送算力限制会员赠送算力仅用于数字员工运行,不可用于聘用员工,不可转赠、转回收益或提现;到期额度不会转入下一周期。

打开会员中心 →

使用与资产

充值、消费与员工收入

充值中心用于购买普通算力并查看支付订单;消费记录按模型、工具、联网、知识检索和资源用量等真实项目归类;员工收益中心仅面向发布了收费数字员工的开发者。

普通算力充值和收益转回进入普通算力账户,与会员赠送算力分开显示。消费记录显示任务扣费、资源结算和收益转回等账户变动;员工订阅收入不再混入消费记录。员工收益可查看订阅人、员工、周期、申请编号和结算详情;收益可转回普通算力。提现仅在平台开放提现时可提交,支持平台当前提供的收款渠道;详情会显示换算后的预计到账金额、状态和拒绝理由。换算基准平台统一使用 1 USD = 1,000 算力点 = 7.8 HKD 进行收益与港币金额换算。
平台资源 · 01

资源库、容量与结算规则

资源库用于保存数字员工可调用的轻量文件、模板、成果和加密连接引用,不是无限网盘。文件内容与员工输出默认存放在对象存储,网页服务器只保存元数据和临时任务状态;每个账户默认总容量为 1024 MB。

容量与文件限制

默认空间每个账户总容量 1024 MB;管理员可以按会员或账户规则调整上限。上传限制普通文件默认 5 MB、模板 10 MB、图片 3 MB;单个员工默认最多 50 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 算力点结算,实际扣费以资源库每日结算记录为准。

每日结算与欠费

  1. 1系统按前一自然日汇总账户存储和实际下载流量,每天自动生成一条结算记录;GET、PUT、DELETE、List 仍保留在诊断明细中。
  2. 2先计算“应扣算力”,再从账户余额扣除“实际扣除算力”;余额不足时只扣现有余额,剩余部分记录为“未结算”。
  3. 3后续充值或余额恢复后,系统按最早日期优先补扣欠费,并在资源库账单和后台“系统结算记录”中保留明细。
  4. 4管理员可以按日期、账户和状态查看应扣、实扣、未结、存储容量、请求量、下载流量和费用明细。

调用与计费边界

员工读取知识库、企业资源或绑定文件时会记录读取事件;上传成果、删除文件、更新属性和列举目录会记录写入事件,但这些请求不向客户收费;向用户浏览器或外部系统传输文件时才记录下载外网流量并计费。

打开资源库 →

开发接口

DIGITAL EMPLOYEE API

接口概览

API 面向需要把已授权数字员工接入网站、企业 OA、CRM 或自动化流程的开发者。调用前需要账户 API Key、员工证中的 Agent ID,且目标员工必须已经发布、运行正常并允许 API 访问。

在哪里找到 Agent ID进入“员工工作室”,选择员工后点击对话区顶部的员工证图标,或在“员工设置 → 基本”点击“查看员工证”。员工证中的完整 ID 就是接口路径里的 {agentId},自有员工、市场员工和聘用后的员工使用同一个唯一 ID。

最小接入清单

  1. 1在“开发与集成 → API 凭证”创建 API Key,至少勾选 agent:run 和 run:read。
  2. 2确认员工已发布并开启 API 输出;聘用他人员工时还需授权仍在有效期内。
  3. 3使用 POST /v1/agents/{agentId}/responses 创建异步任务,并保存返回的 Run ID。
  4. 4通过状态接口、SSE 或签名 Webhook 接收结果;文件下载还需 artifact:read 权限。
业务系统→选择员工→创建任务→读取输出
开发接口

会员运行限制

会员页面中的 API 每分钟请求、最长任务、记录保留和队列优先级均已接入真实运行链路,不是展示字段。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 接收结果,不要高频轮询。历史资料需要长期使用时,应在过期前保存到企业资源库。
POST

/v1/agents/{agentId}/responses

创建异步数字员工任务。平台按费率收取员工基础费、单次最低费用,并叠加模型 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 端点。

202 响应

{"id":"run_uuid","object":"agent.run","status":"queued","replayed":false}
避免重复扣费网络超时重试时复用同一个 Idempotency-Key。相同 API Key 下,服务端会返回原任务并标记 replayed: true,不会再次创建任务或冻结算力。
GET

/v1/runs/{runId}

读取任务状态、输出、用量和交付次数。任务在服务器端持续执行,与调用方页面是否打开无关;调用方应先判断 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,财务与审计记录不受影响。
开发接口

事件流与 Webhook

短任务可轮询状态;需要实时进度时使用 SSE;企业系统需要可靠异步交付时,在“开发与集成 → API 凭证”创建 Webhook,并在创建任务时传入端点 ID。

SSEGET /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 投递记录和控制台任务中心交叉核对。

  1. 1记录请求时间、环境、API Key 前缀、Agent ID、Idempotency-Key 和响应状态码;不要记录完整密钥。
  2. 2创建成功后保存 Run ID。即使页面关闭或网络断开,Run ID 仍可用于查询服务器端任务。
  3. 3在任务中心搜索 Run ID,核对数字员工、任务来源、实际模型、执行状态、费用和失败原因。
  4. 4Webhook 未到达时,在 API 凭证页面检查端点是否启用、最近状态、重试次数和错误;同时确认公网 HTTPS 地址可访问。
  5. 5联系支持时提供 Run ID、发生时间和错误码。密钥、Webhook Secret、数据库密码和第三方 Token 不应通过工单发送。
轮询建议不要每秒刷新整个业务页面。短任务可从 2 秒开始轮询并逐步退避;长任务优先使用 SSE 或 Webhook,遇到 429 必须遵守 Retry-After。

打开 API 参考 →

开发接口

错误处理

错误码含义处理
invalid_api_key密钥无效、已撤销或已过期检查 Bearer 格式,必要时重新创建密钥
api_scope_requiredAPI 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任务成果已过期从资源库读取副本或重新运行任务
5xx 与网络错误对创建任务的重试必须复用同一个 Idempotency-Key;查询和下载可使用指数退避。持续失败时保留 Run ID、时间和错误码后联系支持。