SuperAPI AI 工具集

iblai-api-profile-metadata

编程与开发

查看项目

更新于 10-15 22:16

技能介绍

用途:通过 iblai 平台 API 读写按用户、按组织隔离的元数据,作为键值存储保存用户偏好、应用设置、功能开关和引导进度。所有操作都访问同一端点 …/dm/api/core/users/platform-metadata/,默认作用于当前登录用户,组织管理员可指定其他用户。

主要能力:每个(用户名,组织)组合对应一个 JSON 对象,同一用户在不同组织中的元数据相互独立。键为任意字符串,值为任意 JSON(字符串、数字、布尔、嵌套对象或数组),API 不强制 schema、命名空间或值类型。首次使用时自动创建记录,无元数据的 GET 返回 "metadata": {}(200,不会 404)。

使用方式:基础地址 https://api.iblai.app,每个请求带请求头 Authorization: Api-Token $IBLAI_API_KEY,路径变量 {org} 以 platform_key 查询参数传入,{username} 为 $IBLAI_USERNAME。未连接时先运行 /iblai-api-login 填充 IBLAI_ORG、IBLAI_USERNAME、IBLAI_API_KEY。GET 读取完整元数据对象;PATCH 合并更新或删除指定键,需至少提供 metadata 或 delete_keys 之一,先更新后删除;PUT 用所给 metadata 整体替换,未包含的键全部丢弃;DELETE 将元数据重置为 {}(记录保留),返回 204 无内容。管理员在请求中追加 &username={other_user} 可操作其他用户,需具备该组织的管理员权限。

适用场景:保存用户偏好、功能开关、引导进度,以及同一用户跨多组织的独立配置。

限制:PATCH 适合增量更新,PUT 与 DELETE 具有破坏性,使用前应确认。缺少 platform_key 返回 400,未知 platform_key 返回 404,PATCH 未提供 metadata 或 delete_keys 返回 400,PUT 的 metadata 非对象返回 400,无管理员权限跨用户访问返回 403,目标用户不存在返回 404,缺少或无效认证头返回 401。仅 metadata 可写,username、platform_key、created_at、updated_at 为只读,时间戳为 ISO 8601。