开发者文档

请求、响应与错误

JSON 请求与响应,按业务错误恢复。

接口前缀为 /api。GET 参数放查询字符串,其他方法使用 JSON 请求体;DELETE 也可能需要交接字段。列表是否分页、可用的筛选及页码限制见各接口定义,不是所有列表都支持分页。

金额字段 amountFen、budgetFen 等以分计;项目起止日期为日历日期,发布时间筛选按北京时间自然日,时间戳使用 ISO 8601。字段规则以 JSON Schema 和业务校验为准。

错误结构
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "提交内容无效",
    "details": [
      {
        "path": [
          "name"
        ],
        "message": "字段校验失败"
      }
    ]
  },
  "requestId": "服务端请求ID"
}
HTTP 状态处理方式
400检查字段格式、必填项与业务条件
401会话或 Key 无效、撤销、过期或未授权应用;到账号中心检查
403检查工作区权限、账号状态和 CSRF_REJECTED 来源校验
404资源不存在或不在当前可访问范围
409冲突或状态锁定,重新读取资源后处理
410CENTRAL_IDENTITY_REQUIRED:旧账号接口已退役
415使用 application/json 请求体
429降低调用频率,遵守服务端限流
503服务忙或依赖不可用,查询可退避重试

失败时保留响应 requestId 或 X-Request-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
materialFetchPOST/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
sharePreviewPOST/api/publishing-shares/:token/preview
回填作品链接POST/api/publishing-shares/:token/submissions
获取任务文件地址GET/api/publishing-shares/:token/files/:id
我的发布任务GET/api/my/publishing-tasks
socialAccountCreatePOST/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
recoveredContentDeletePATCH/api/orgs/:orgId/recovered-contents/:id/delete
编辑回收内容PATCH/api/orgs/:orgId/recovered-contents/:id
更正回收平台PATCH/api/orgs/:orgId/recovered-contents/:id/platform
recoveredContentCollectPOST/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