开发者文档
快速开始
从读取一个真实工作区开始。
- 打开工作台并完成统一登录。
- 调用 GET /api/auth/me，确认返回的 user。
- 调用 GET /api/orgs，从返回的 items 选择工作区 ID。
- 调用 GET /api/orgs/:orgId/projects 查看项目。
浏览器 · 同源执行
const orgResponse = await fetch("/api/orgs", { credentials: "include" });
if (!orgResponse.ok) throw new Error("读取工作区失败");
const { data: { items } } = await orgResponse.json();
// 由用户选择目标工作区，不默认使用第一个
const orgId = "替换为用户选择的工作区ID";
if (!items.some((org) => org.id === orgId)) throw new Error("无工作区权限");
const response = await fetch(`/api/orgs/${encodeURIComponent(orgId)}/projects?page=1&pageSize=20`, { credentials: "include" });
if (!response.ok) throw new Error("读取项目失败");
console.log(await response.json());完整请求字段、枚举和约束见对应接口。业务 ID 来自真实查询结果，示例字符串不能直接用于生产调用。
能力边界
当前支持工作区、成员小组、素人档案、种草项目、作品链接回收、发布计划、任务领取与回填、会员及积分相关查询和流程。自动采集效果、平台自动发布、费用结算与付款尚未接入。
平台管理与已退役接口
以下平台 API 仅供平台管理员，未纳入普通用户 Agent 描述。平台角色不自动授予工作区数据访问权。
GET /api/admin/audit-logs
GET /api/admin/overview
GET /api/admin/users
PATCH /api/admin/users/:id/status
GET /api/admin/organizations
PATCH /api/admin/organizations/:id/status
GET /api/admin/runtime
GET /api/admin/metrics
GET /api/admin/membership-plans
POST /api/admin/membership-plans
PATCH /api/admin/membership-plans/:id
GET /api/admin/membership-orders
POST /api/admin/membership-orders/:id/confirm
POST /api/admin/organizations/:id/membership
GET /api/admin/organizations/:id/membership
POST /api/auth/register、POST /api/auth/login、PATCH /api/auth/profile、POST /api/auth/password 已退役，返回 410；统一账号的登录与资料管理由账号中心负责。OIDC callback 是服务端回调，不是 Agent 工具。
接口目录 100
搜索支持接口名称、HTTP 方法和路径。点击名称查看参数、权限及完整结构。
| 接口 | 方法 | 路径 |
|---|---|---|
| 确认作品结算 | POST | /api/orgs/:orgId/recovered-contents/:id/settlement |
| 追加作品费用 | POST | /api/orgs/:orgId/settlements/:id/additions |
| 撤销作品结算 | POST | /api/orgs/:orgId/settlements/:id/reverse |
| 项目结算列表 | GET | /api/orgs/:orgId/settlements |
| 作品结算明细 | GET | /api/orgs/:orgId/settlements/:id |
| 素人合作账单 | GET | /api/orgs/:orgId/creators/:id/statement |
| 登记线下付款 | POST | /api/orgs/:orgId/creators/:id/payments |
| 撤销付款登记 | POST | /api/orgs/:orgId/cooperation-payments/:id/reverse |
| 我的合作钱包 | GET | /api/my/cooperation-wallets |
| 我的合作账单 | GET | /api/my/cooperation-wallets/:id/statement |
| materialFetch | POST | /api/orgs/:orgId/materials/fetch |
| 发布计划列表 | GET | /api/orgs/:orgId/publishing-plans |
| 创建发布计划 | POST | /api/orgs/:orgId/publishing-plans |
| 发布计划详情 | GET | /api/orgs/:orgId/publishing-plans/:id |
| 删除发布计划 | DELETE | /api/orgs/:orgId/publishing-plans/:id |
| 修改发布计划 | PATCH | /api/orgs/:orgId/publishing-plans/:id |
| 内容组详情 | GET | /api/orgs/:orgId/publishing-groups/:id |
| 保存图组图片顺序 | PATCH | /api/orgs/:orgId/publishing-groups/:id/images-order |
| 保存计划正文 | PATCH | /api/orgs/:orgId/publishing-groups/:id/document |
| 获取文件上传签名 | POST | /api/orgs/:orgId/publishing-groups/:id/uploads |
| 确认文件上传 | POST | /api/orgs/:orgId/publishing-files/:id/complete |
| 删除计划文件 | DELETE | /api/orgs/:orgId/publishing-files/:id |
| 生成分享链接 | POST | /api/orgs/:orgId/publishing-plans/:id/publish |
| 停止发布计划 | POST | /api/orgs/:orgId/publishing-plans/:id/stop |
| 获取计划文件地址 | GET | /api/orgs/:orgId/publishing-files/:id/url |
| 分享任务详情 | GET | /api/publishing-shares/:token |
| 领取分享任务 | POST | /api/publishing-shares/:token/claim |
| sharePreview | POST | /api/publishing-shares/:token/preview |
| 回填作品链接 | POST | /api/publishing-shares/:token/submissions |
| 获取任务文件地址 | GET | /api/publishing-shares/:token/files/:id |
| 我的发布任务 | GET | /api/my/publishing-tasks |
| socialAccountCreate | POST | /api/orgs/:orgId/social-accounts |
| 平台账号列表 | GET | /api/orgs/:orgId/social-accounts |
| 审核素人档案 | PATCH | /api/orgs/:orgId/creators/:id/review |
| 审核平台账号 | PATCH | /api/orgs/:orgId/social-accounts/:id/review |
| 项目负责人选项 | GET | /api/orgs/:orgId/project-owners |
| recoveredContentDelete | PATCH | /api/orgs/:orgId/recovered-contents/:id/delete |
| 编辑回收内容 | PATCH | /api/orgs/:orgId/recovered-contents/:id |
| 更正回收平台 | PATCH | /api/orgs/:orgId/recovered-contents/:id/platform |
| recoveredContentCollect | POST | /api/orgs/:orgId/recovered-contents/collect |
| 批量回收作品链接 | POST | /api/orgs/:orgId/recovered-contents/batch |
| 项目名称选项 | GET | /api/orgs/:orgId/project-options |
| 内容回收列表 | GET | /api/orgs/:orgId/recovered-contents |
| 种草项目列表 | GET | /api/orgs/:orgId/projects |
| 种草项目详情 | GET | /api/orgs/:orgId/projects/:id |
| 创建种草项目 | POST | /api/orgs/:orgId/projects |
| 修改种草项目 | PATCH | /api/orgs/:orgId/projects/:id |
| 共享积分状态 | GET | /api/orgs/:orgId/shared-credits |
| 发起共享积分授权 | POST | /api/orgs/:orgId/shared-credits/authorize |
| 完成共享积分授权 | POST | /api/orgs/:orgId/shared-credits/complete |
| 积分划转记录 | GET | /api/orgs/:orgId/credit-transfers |
| 创建积分划转 | POST | /api/orgs/:orgId/credit-transfers |
| 同步积分划转 | POST | /api/orgs/:orgId/credit-transfers/sync |
| 重试积分划转 | POST | /api/orgs/:orgId/credit-transfers/:id/retry |
| 成员分组列表 | GET | /api/orgs/:orgId/groups |
| 创建成员分组 | POST | /api/orgs/:orgId/groups |
| 成员分组详情 | GET | /api/orgs/:orgId/groups/:id |
| 修改成员分组 | PATCH | /api/orgs/:orgId/groups/:id |
| 解散成员分组 | DELETE | /api/orgs/:orgId/groups/:id |
| 小组成员列表 | GET | /api/orgs/:orgId/groups/:id/members |
| 添加小组成员 | POST | /api/orgs/:orgId/groups/:id/members |
| 移除小组成员 | DELETE | /api/orgs/:orgId/groups/:id/members/:userId |
| 设置小组组长 | PATCH | /api/orgs/:orgId/groups/:id/leader |
| 分配素人责任 | POST | /api/orgs/:orgId/creator-assignments |
| 存活检查 | GET | /api/health/live |
| 就绪检查 | GET | /api/health/ready |
| 当前账号会话 | GET | /api/auth/sessions |
| 撤销指定会话 | DELETE | /api/auth/sessions/:id |
| 撤销其他会话 | POST | /api/auth/sessions/revoke-others |
| 我的工作区 | GET | /api/orgs |
| 创建工作区 | POST | /api/orgs |
| 工作区详情 | GET | /api/orgs/:orgId |
| 修改工作区 | PATCH | /api/orgs/:orgId |
| 工作台概览 | GET | /api/orgs/:orgId/dashboard |
| 工作区统计 | GET | /api/orgs/:orgId/overview |
| 工作区成员 | GET | /api/orgs/:orgId/members |
| 设置成员角色 | PATCH | /api/orgs/:orgId/members/:userId |
| 移除工作区成员 | DELETE | /api/orgs/:orgId/members/:userId |
| 退出工作区 | POST | /api/orgs/:orgId/leave |
| 转让工作区 | POST | /api/orgs/:orgId/transfer |
| 邀请列表 | GET | /api/orgs/:orgId/invitations |
| 创建成员邀请 | POST | /api/orgs/:orgId/invitations |
| 撤销成员邀请 | DELETE | /api/orgs/:orgId/invitations/:id |
| 查看成员邀请 | GET | /api/invitations/:token |
| 接受成员邀请 | POST | /api/invitations/:token/accept |
| 工作区操作日志 | GET | /api/orgs/:orgId/audit-logs |
| 工作区积分账单 | GET | /api/orgs/:orgId/point-entries |
| 同步统一账号资料 | POST | /api/auth/profile/sync |
| 当前登录用户 | GET | /api/auth/me |
| 退出登录 | POST | /api/auth/logout |
| 素人档案列表 | GET | /api/orgs/:orgId/creators |
| 素人档案详情 | GET | /api/orgs/:orgId/creators/:id |
| 创建素人档案 | POST | /api/orgs/:orgId/creators |
| 修改素人档案 | PATCH | /api/orgs/:orgId/creators/:id |
| 会员套餐 | GET | /api/membership-plans |
| 工作区会员权益 | GET | /api/orgs/:orgId/billing |
| 会员订单列表 | GET | /api/orgs/:orgId/membership-orders |
| 创建会员订单 | POST | /api/orgs/:orgId/membership-orders |
| 取消会员订单 | POST | /api/orgs/:orgId/membership-orders/:id/cancel |
| 切换免费版本 | POST | /api/orgs/:orgId/membership/free |