ProfileClaw
API 总览

先理解一层契约,再按任务分流

这一页按开发任务组织公开 API,帮助团队从鉴权和 context 进入 profile、planning 与 operations,而不是在端点列表里自己猜结构。

信息

推荐顺序:先鉴权,再 context,最后进入任务接口。

大多数集成第一天并不需要全部端点。先验证 key,拿到聚合上下文,再在工作流证明需要时进入 prediction、health 或 webhook。

基础层

先从稳定的接入原语开始

这些入口负责定义身份、默认读取路径和失败姿态。

鉴权

请求头、scope 与 onboarding 顺序。

Context API

大多数 agent 与应用的默认聚合入口。

错误处理

机器可读错误与恢复姿态。

画像层

读取更结构化的用户职业画像

当默认 context 不够时,再进入这些更完整的读取接口。

Profile API

归一化后的职业档案与身份层。

Career Graph API

用于推荐与解释的完整结构化职业图谱。

Assessments API

测评信号与最新结果。

Career Context API

用于 query-specific 读取的紧凑动态上下文。

决策层

规划与推荐类接口

这些接口更适合面向未来的分析、规划与发现类场景。

Career Prediction API

预测更可能出现的角色迁移与路径概率。

Career Reasoning API

结合画像与记忆执行更深的职业分析。

Similar Paths API

查找与当前用户相似的匿名职业路径样本。

Career Match API

查看 bucket 化匹配结果与解释因素。

运行层

事件、健康信号与用户控制

当你的集成需要增量同步、风险信号或偏好管理时,进入这一层。

Alerts API

读取和处理职业提醒。

Career Health API

读取健康指标、趋势与建议。

Data Sharing API

读取或更新数据共享偏好。

Webhooks API

管理事件驱动同步所需的订阅。