API 文档

Orchify REST API 参考手册。所有请求需携带有效的 Session Cookie 或 API Token。

Base URL：https://api.orchify.dev

认证

GET/auth/github发起 GitHub OAuth 授权流程

GET/auth/github/callbackGitHub OAuth 回调处理

POST/api/auth/logout退出登录，清除会话

GET/api/workspaces获取当前用户所属的所有 Workspace 列表

POST/api/workspaces创建新的 Workspace

GET/api/workspaces/:id获取指定 Workspace 详情

PATCH/api/workspaces/:id更新 Workspace 基本信息

DELETE/api/workspaces/:id删除 Workspace（需 owner 权限）

GET/api/workspaces/:id/members获取 Workspace 成员列表

POST/api/workspaces/:id/invitations邀请成员加入 Workspace

PATCH/api/workspaces/:id/members/:userId变更成员角色

DELETE/api/workspaces/:id/members/:userId移除成员

GET/api/workspaces/:id/projects获取 Workspace 下的项目列表

POST/api/workspaces/:id/projects创建项目

GET/api/projects/:id获取项目详情

PATCH/api/projects/:id更新项目配置

DELETE/api/projects/:id删除项目

GET/api/projects/:id/runs获取项目下的编排运行列表

POST/api/projects/:id/runs提交新的编排需求，启动运行

GET/api/runs/:id获取编排运行详情及任务 DAG

POST/api/runs/:id/cancel取消正在执行的运行

POST/api/runs/:id/retry重试失败的运行

GET/api/tasks/:id获取单个任务详情

GET/api/tasks/:id/logs获取任务执行日志（支持流式）

GET/api/tasks/:id/artifacts获取任务产出物列表

GET/api/workspaces/:id/runners获取 Workspace 下的 Runner 列表

POST/api/workspaces/:id/runners/tokens生成新的 Runner Token

DELETE/api/runners/:id注销 Runner

需要详细的请求/响应格式、错误码说明或 SDK 接入指南？请联系技术支持团队。