OPEN-OX

// docs / api

API 参考

Open-OX Studio 的 HTTP 接口均为 Next.js Route Handlers,与前端同域。生成与修改类接口多为 text/event-stream (SSE)。Workspace 默认私有;社区发现走独立 Community 路由。

Workspace 项目

POST/api/projects创建项目,返回 projectId(需登录;可选 imageBase64 / folderId)
GET/api/projects仅当前用户项目;folder=all|uncategorized|uuid(all=根目录 folder_id null);offset / limit
GET/api/projects/galleryWorkspace 画廊列表(同上范围,含封面元数据;客户端再拉 cover)
GET/api/projects/[id]项目详情(轮询生成进度;所有者或已发布可见字段)
PATCH/api/projects/[id]重命名、移动文件夹、Publish Preview / Allow Remix
DELETE/api/projects/[id]删除项目及关联文件(所有者)
POST/api/projects/[id]/remix从可 Remix 的社区项目拷贝到自己的 Workspace
GET/api/projects/[id]/export导出本地工作区 ZIP

Community

GET/api/community/projects公开列表(Publish Preview + listed);无需登录
GET/api/community/projects/[id]社区项目摘要(已发布)

生成与修改

POST/api/ai启动生成流水线(SSE,需 projectId)
POST/api/ai/intent-agent生成前 Intent Agent 对话轮次(SSE)
POST/api/projects/[id]/modify启动修改 Agent(SSE)
GET/api/projects/[id]/memory读取工作记忆投影 / 合并历史(调试)

Design Mode

POST/api/projects/[id]/design-mode/patchDirect Apply:源坐标 + JSX AST 写盘(需 local preview + feature flag)
POST/api/projects/[id]/design-mode/backfill为历史源码补齐 data-ox-source 锚点

预览、封面与文件

POST/api/projects/[id]/preview启动/刷新预览(local / storage / e2b 由环境决定)
PUT/api/projects/[id]/preview代码变更后增量重建预览
GET/api/projects/[id]/preview健康检查 + 自动恢复
GET/api/projects/[id]/preview/status沙箱 / 构建状态
GET/api/projects/[id]/cover封面图(未发布时非所有者不可访问)
POST/api/projects/[id]/cover/capture触发封面截图捕获
GET/api/projects/[id]/files列出 Storage 中的文件
POST/api/projects/[id]/files从 Storage 恢复到工作区
PUT/api/projects/[id]/files将工作区文件上传到 Storage

文件夹

GET/api/folders当前用户的项目文件夹列表
POST/api/folders创建文件夹
GET/api/folders/[id]文件夹详情(含项目数)
DELETE/api/folders/[id]解散文件夹:项目移回根目录后删除文件夹行

模型与技能

GET/api/models可用 LLM 模型列表(含 DB 自定义模型)
GET/api/skills风格技能 id / 标签(Hero「/」菜单)

会话与认证

GET/api/auth/user当前登录用户(含 user_metadata)
GET/api/auth/config当前启用的登录提供商(飞书 / Google)
GET/api/auth/feishu/start飞书 OAuth 授权跳转
GET/api/auth/feishu/callback飞书 OAuth 回调,建立会话
GET/api/auth/google/startGoogle OAuth 授权跳转
更完整的请求流程与数据流说明见 系统架构 → API 路由;产品面划分见 产品面