仅在使用时加载搜索。在下方浏览所有类别。
SosoAPI · 开发者文档
API 参考
107 个可从应用调用的操作,另有 4 个 agent 登录端点。开启操作即可查看请求字段、响应、权限与调用示例。
账号与工作区
- 获取 组织 信息
POST /identity-api/agent/organization-context读取实时组织、工作区和频道权限。 - 创建 API key
POST /identity-api/api-keys/create使用选定能力及可选的 工作区 限制创建 API key;密钥只返回一次。agent 只能授予自己已有的授权,最长 30 天,每项授权最多可有 25 个有效 keys(API_KEY_GRANT_KEY_LIMIT)。 - 延长 API key 有效期
POST /identity-api/api-keys/extend将 API key 到期时间延长至从现在起最多 365 天(agent 创建的 key 为 30 天);更晚时间会以 API_KEY_LIFETIME_EXCEEDS_CAP 拒绝。响应包含实际应用的到期时间。 - 列出 API keys
POST /identity-api/api-keys/list列出 API key 元数据,不含密钥;设置 include_authority 可获取能力与 工作区 限制。 - 换发 API key
POST /identity-api/api-keys/renew以相同能力及 工作区 限制,创建不影响原 key 的接替 API key。 - 撤销 API key
POST /identity-api/api-keys/revoke撤销 API key。agent 只能撤销自己创建的 key。 - 获取计费状态
POST /identity-api/billing/status读取计费套餐、权益和配额信息。 - 获取商业访问权限
POST /identity-api/commercial-access/status读取 工作区 商业访问信息。 - 提交反馈
POST /identity-api/feedback/submit提交具有来源归属的产品回馈。 - 列出工作区成员
POST /identity-api/member/list读取成员与待处理邀请。 - 列出组织频道
POST /identity-api/organization/channels/list列出频道和工作区关联状态。 - 预览频道移动
POST /identity-api/organization/channels/move/preview移动频道前预览阻碍因素。 - 列出组织连接
POST /identity-api/organization/connections/list读取组织平台连接。 - 审核组织连接
POST /identity-api/organization/connections/review读取已发现、供审核的确切平台资源。 - 列出组织
POST /identity-api/organization/list列出已验证用户可见的组织。 - 列出收件匣通知
POST /identity-api/user/inbox/list读取已验证用户的收件匣。 - 获取通知偏好
POST /identity-api/user/notifications/get读取通知发送偏好。 - 更新通知偏好
POST /identity-api/user/notifications/update更新通知发送偏好。 - 获取用户资料
POST /identity-api/user/profile/get读取已通过身份验证的用户资料。 - 生成头像上传签名
POST /identity-api/user/profile/sign-avatar-url获取已签名的头像上传 URL。 - 更新用户资料
POST /identity-api/user/profile/update更新已验证用户的个人资料。 - 解除社交账号封锁
POST /identity-api/user/social-accounts/clear-block解除账号冷却,但不重试帖子。冷却仍生效或账号已达第三次冷却时,agent 凭证会遭拒;任何调用方对同一账号每 10 分钟最多可解除一次。 - 断开社交账号连接
POST /identity-api/user/social-accounts/disconnect中断 工作区 社交账号链接。 - 列出已连接账号
POST /identity-api/user/social-accounts/list列出 工作区 中已链接的社交账号。 - 设置社交账号自动同步
POST /identity-api/user/social-accounts/set-auto-sync启用或禁用账号自动同步。 - 创建 工作区
POST /identity-api/workspace/create在你拥有或管理的组织中创建工作区。属于多个组织时,传入 organization_id。 - 获取工作区上下文
POST /identity-api/workspace/list列出工作区及活动工作区。 - 更新 工作区
POST /identity-api/workspace/update更新 工作区 名称或代称。
媒体与素材
- 创建素材
POST /assets-api/create登记素材元数据。 - 删除素材
POST /assets-api/delete删除单个素材。 - 创建素材导出
POST /assets-api/exports/create创建素材导出证据工作。 - 获取素材导出状态
POST /assets-api/exports/status读取持久化素材导出状态。 - 验证素材导出
POST /assets-api/exports/verify任何彻底删除前,先验证素材导出。 - 获取素材
POST /assets-api/get通过 ID 读取单个素材。 - 获取素材导入状态
POST /assets-api/imports/status读取持久化媒体导入状态。 - 导入素材 URL
POST /assets-api/imports/url将明确指定的外部媒体导入加入伫列。 - 查询素材
POST /assets-api/list使用兼容旧版的筛选条件查询素材。 - 列出素材
POST /assets-api/list-workspace列出工作区素材。 - 删除孤立素材
POST /assets-api/orphans/delete删除所选未登记的 R2 对象。 - 列出孤立素材
POST /assets-api/orphans/list列出未登记的 R2 对象。 - 请求彻底删除素材
POST /assets-api/purges/request请求受所有者隔离防护约束的素材彻底删除。 - 重试彻底删除素材
POST /assets-api/purges/retry重试符合资格且受栅栏保护的清除操作。 - 获取素材存储清单
POST /assets-api/storage/inventory读取有范围限制的已登记素材/对象存储清单。 - 更新素材
POST /assets-api/update更新素材元数据。 - 完成素材上传
POST /assets-api/upload/complete使用已签署的对象身分与幂等键,完成已上传 工作区 媒体对象的登记。 - 生成素材上传签名
POST /assets-api/upload/sign为预期的 工作区 媒体对象请求签署上传 URL。请先上传位元组,再完成登记。
项目与内容
- 获取项目账号默认值
POST /studio-api/projects/account-defaults/get读取项目账号默认值。 - 替换项目账号默认值
POST /studio-api/projects/account-defaults/replace替换项目账号默认值。 - 关联项目账号
POST /studio-api/projects/accounts/link将社交账号关联到项目。 - 列出项目账号
POST /studio-api/projects/accounts/list列出项目关联的账号。 - 取消关联项目账号
POST /studio-api/projects/accounts/unlink取消社交账号与项目的关联。 - 归档项目
POST /studio-api/projects/archive归档项目,不更改其 Scheduled Posts。如需停止帖子,请单独取消该 Scheduled Post。仅限工作区所有者;传入 expected_lifecycle_version 和 idempotency_key。 - 关联项目素材
POST /studio-api/projects/assets/link将素材关联到项目。 - 列出项目素材
POST /studio-api/projects/assets/list列出关联到项目的素材。 - 取消关联项目素材
POST /studio-api/projects/assets/unlink解除素材与项目的关联。 - 创建项目
POST /studio-api/projects/create创建一个项目。 - 创建项目导出
POST /studio-api/projects/export/create创建项目导出。 - 获取项目导出状态
POST /studio-api/projects/export/status读取项目导出状态。 - 获取项目
POST /studio-api/projects/get读取一个项目。 - 获取项目生命周期历史
POST /studio-api/projects/lifecycle/history读取项目生命周期历史。 - 列出项目
POST /studio-api/projects/list列出 工作区 项目。 - 获取项目资料
POST /studio-api/projects/profile/get读取项目资料。 - 更新项目资料
POST /studio-api/projects/profile/update更新项目资料。 - 设置使用中项目
POST /studio-api/projects/set-active设置使用中项目。 - 取消归档项目
POST /studio-api/projects/unarchive重新启用已归档项目。不会恢复或重新排程帖子;请通过排程帖子另行管理。仅限 工作区 所有者;请传入 expected_lifecycle_version 及 idempotency_key。 - 更新项目
POST /studio-api/projects/update更新项目。 - 列出待处理发布事项
POST /studio-api/publication-attentions/list读取需要注意的发布结果。
排程与发布
- 批次创建排程帖子
POST /studio-api/scheduled-posts/bulk-create为多个目标创建排程帖子。 - 取消排程帖子
POST /studio-api/scheduled-posts/cancel取消排程帖子。 - 创建排程帖子
POST /studio-api/scheduled-posts/create创建排程帖子并检查最终发布结果。 - 提交完整图片帖子
POST /studio-api/scheduled-posts/create-image-url持久接受一篇完整的图片 URL 帖子,并在最终结果可用时返回。 - 删除排程帖子
POST /studio-api/scheduled-posts/delete删除排程帖子。 - 获取排程帖子资格
POST /studio-api/scheduled-posts/eligibility排程前读取目标资格。 - 获取排程帖子
POST /studio-api/scheduled-posts/get读取单个排程帖子。 - 列出排程帖子
POST /studio-api/scheduled-posts/list列出排程帖子。 - 立即发布排程帖子
POST /studio-api/scheduled-posts/publish-now请求立即发布。 - 重试排程帖子
POST /studio-api/scheduled-posts/retry重试失败的排程帖子。 - 更新排程帖子
POST /studio-api/scheduled-posts/update更新一篇排程帖子。 - 撤回删除请求
POST /studio-api/scheduled-posts/withdraw-delete撤回已停止的 Instagram Login 删除请求,并保留已发布帖子。 - 获取 X 发布积分
POST /studio-api/x/usage读取共享的组织 X 积分,以及可选最终帖子 text 的积分成本。
分析与洞察
- 获取仪表板计数
POST /analytics-api/dashboard/ops-counts读取仪表板运营计数。 - 请求平台洞察
POST /analytics-api/provider-insights/request请求以平台为权威来源的洞察。 - 获取平台洞察状态
POST /analytics-api/provider-insights/status读取平台洞察请求状态。 - 列出帖子留言
POST /analytics-api/social/comments/query读取已发现的社交评论。 - 列出监测中的帖子
POST /analytics-api/social/posts/query读取已探索到的社交帖子。
社交连接
- 启动 Instagram OAuth
POST /oauth-api/instagram/init开始平台同意流程并返回原生授权 URL。 - 更新 Instagram OAuth
POST /oauth-api/instagram/refresh刷新 Instagram 连接。 - 启动 Meta OAuth
POST /oauth-api/meta/init开始平台同意流程并返回原生授权 URL。 - 刷新 Meta OAuth
POST /oauth-api/meta/refresh更新 Meta 连接。 - 检查 Threads OAuth
POST /oauth-api/threads/check读取 Threads 连接诊断。 - 启动 Threads OAuth
POST /oauth-api/threads/init开始平台同意流程并返回原生授权 URL。 - 更新 Threads OAuth
POST /oauth-api/threads/refresh更新 Threads 连接。 - 启动 YouTube OAuth
POST /oauth-api/youtube/init开始平台同意流程并返回原生授权 URL。 - 更新 YouTube OAuth
POST /oauth-api/youtube/refresh刷新 YouTube 连接。
背景操作
留言与社区
- 执行社区操作
POST /community-engagement-api/actions/apply执行已准备的操作;检查操作状态以确定最终事实。 - 准备社区操作
POST /community-engagement-api/actions/prepare准备终端社区操作。 - 获取社区操作状态
POST /community-engagement-api/actions/status读取最终操作回执;入队不代表成功。 - 获取社区能力
POST /community-engagement-api/capabilities读取社区互动能力信息。 - 创建社区评论
POST /community-engagement-api/comments/create将针对规范帖子或评论目标的一条确切评论加入队列;状态不等于平台成功。 - 获取评论交付结果
POST /community-engagement-api/comments/outcome读取已确认交付、恢复链、待验证事项和未解决的后续事项。 - 核对留言交付结果
POST /community-engagement-api/comments/reconcile在不重送的情况下验证结果不明的 Facebook 发送,或链接一篇已确认完全相符的替代帖子。请检查 outcome 以获取终端证明。 - 获取社区留言状态
POST /community-engagement-api/comments/status读取直接评论操作经过脱敏的最终回执。 - 获取社区摘要
POST /community-engagement-api/operations/summary读取 Community Engagement 操作摘要。 - 查询社区审核伫列
POST /community-engagement-api/review-queue/query读取可审核评论;空白页面不代表成功。 - 提交社区审核
POST /community-engagement-api/reviews/submit提交新的不可变更审核版本。
身份验证引导
- agent 身份验证:config
POST /identity-api/agent-auth/configagent 身份验证 config 协议。使用受支持的浏览器登录流程;绝不显示凭证。 - agent 验证:request
POST /identity-api/agent-auth/requestagent 身份验证 request 协议。使用受支持的浏览器登录流程;绝不显示凭证。 - agent 验证:revoke-current
POST /identity-api/agent-auth/revoke-currentagent 身份验证 revoke-current 协议。使用受支持的浏览器登录流程;绝不显示凭证。 - agent 身份验证:session
POST /identity-api/agent-auth/sessionagent 身份验证 session 协议。使用受支持的浏览器登录流程;绝不显示凭证。