API 参考
Markdown 版这份参考由 OpenAPI 规格生成。标“即将上线”的接口还不存在,不是稳定契约,上线前可能调整。标“需要部署开启”的接口属于部署可选功能,未开启的部署上返回 404。
| Base URL | https://api.mirabase.dev |
|---|---|
| OpenAPI | https://api.mirabase.dev/v2/openapi.yaml |
| 规格版本 | 2.0.0 (33c172f77f2c) |
| 状态 | 115 个已实现(默认部署),12 个已实现(部署可选),3 个即将上线 |
通用请求头
所有接口都接受下面的请求头。通过认证的响应都带 RateLimit-Limit、RateLimit-Remaining 和 RateLimit-Reset,见 限流与限额。分页、幂等、条件请求、任务和错误的规则见 API 约定,全部错误码见 错误码。
| 字段 | 类型 | 说明 |
|---|---|---|
Mirabase-Contract-Version | string | 要协商的契约版本。不传时使用当前兼容的契约。 |
X-Request-Id | string | 调用方关联 id;取值无效时替换为服务端签发的 id。 |
接口分组
Space
- GET
/v2/spaces列出 Space - POST
/v2/spaces创建 Space - GET
/v2/spaces/{space_id}读取 Space - PUT
/v2/spaces/{space_id}按你自己的 id 获取或创建 Space - PATCH
/v2/spaces/{space_id}修改 Space - DELETE
/v2/spaces/{space_id}删除 Space - GET
/v2/spaces/{space_id}/members列出成员 - PUT
/v2/spaces/{space_id}/members/{principal_id}设置成员 - DELETE
/v2/spaces/{space_id}/members/{principal_id}移除成员 - GET
/v2/spaces/{space_id}/processing读取 Space 的处理进度
文件
- GET
/v2/spaces/{space_id}/files读取文件 - HEAD
/v2/spaces/{space_id}/files读取文件响应头 - PUT
/v2/spaces/{space_id}/files写入文件 - PATCH
/v2/spaces/{space_id}/files修改文件文本 - DELETE
/v2/spaces/{space_id}/files删除文件 - POST
/v2/spaces/{space_id}/files/batch批量写入和删除 - GET
/v2/spaces/{space_id}/files/content-url获取文件下载地址 - GET
/v2/spaces/{space_id}/files/diff按路径比较版本 - GET
/v2/spaces/{space_id}/files/lineage按路径查看来源 - POST
/v2/spaces/{space_id}/files/revert按路径回滚 - GET
/v2/spaces/{space_id}/files/versions按路径列出版本
Webhook
- GET
/v2/spaces/{space_id}/webhooks列出 Webhook - POST
/v2/spaces/{space_id}/webhooks创建 Webhook - GET
/v2/webhooks/{webhook_id}读取 Webhook - PATCH
/v2/webhooks/{webhook_id}修改 Webhook - DELETE
/v2/webhooks/{webhook_id}删除 Webhook - GET
/v2/webhooks/{webhook_id}/deliveries列出推送记录 - POST
/v2/webhooks/{webhook_id}/rotate-secret轮换 Webhook 密钥
Entry
- GET
/v2/entries列出 Entry - GET
/v2/entries/{entry_id}读取 Entry - PATCH
/v2/entries/{entry_id}修改 Entry - DELETE
/v2/entries/{entry_id}将 Entry 移入废纸篓 - GET
/v2/entries/{entry_id}/content读取 Entry 内容 - GET
/v2/entries/{entry_id}/content-url获取 Entry 下载地址 - GET
/v2/entries/{entry_id}/copies列出副本即将上线 - GET
/v2/entries/{entry_id}/diff比较版本 - GET
/v2/entries/{entry_id}/lineage查看来源 - GET
/v2/entries/{entry_id}/processing读取处理状态 - POST
/v2/entries/{entry_id}/purge彻底删除 Entry - POST
/v2/entries/{entry_id}/reprocess重新处理 Entry - POST
/v2/entries/{entry_id}/restore恢复 Entry - POST
/v2/entries/{entry_id}/revert回滚到旧版本 - GET
/v2/entries/{entry_id}/versions列出版本 - GET
/v2/entries/{entry_id}/versions/{version_id}读取版本 - PATCH
/v2/entries/{entry_id}/versions/{version_id}/message修改版本说明 - POST
/v2/spaces/{space_id}/trash/purge清空废纸篓
离线整理
- GET
/v2/memory/dreams/{dream_id}读取整理报告需要部署开启 - GET
/v2/memory/dreams/{dream_id}/actions列出整理动作需要部署开启 - GET
/v2/memory/dreams/{dream_id}/judgments列出整理判定需要部署开启 - POST
/v2/memory/dreams/{dream_id}/undo撤销整理需要部署开启 - GET
/v2/memory/proposals/{proposal_id}读取整理提案需要部署开启 - POST
/v2/memory/proposals/{proposal_id}/approve批准整理提案需要部署开启 - POST
/v2/memory/proposals/{proposal_id}/reject驳回整理提案需要部署开启 - GET
/v2/spaces/{space_id}/memory/dreams列出整理需要部署开启 - POST
/v2/spaces/{space_id}/memory/dreams发起整理需要部署开启 - GET
/v2/spaces/{space_id}/memory/proposals列出整理提案需要部署开启 - GET
/v2/spaces/{space_id}/memory/settings读取整理设置需要部署开启 - PATCH
/v2/spaces/{space_id}/memory/settings修改整理设置需要部署开启
分支
- GET
/v2/spaces/{space_id}/branches列出分支 - POST
/v2/spaces/{space_id}/branches创建分支 - GET
/v2/spaces/{space_id}/branches/{branch_id}读取分支 - PATCH
/v2/spaces/{space_id}/branches/{branch_id}重命名或续期分支 - DELETE
/v2/spaces/{space_id}/branches/{branch_id}放弃分支 - GET
/v2/spaces/{space_id}/branches/{branch_id}/checkpoints列出检查点 - POST
/v2/spaces/{space_id}/branches/{branch_id}/checkpoints创建检查点 - GET
/v2/spaces/{space_id}/branches/{branch_id}/diff查看分支改动 - POST
/v2/spaces/{space_id}/branches/{branch_id}/merge合并分支 - GET
/v2/spaces/{space_id}/branches/{branch_id}/objects/{sha256}读取分支对象 - HEAD
/v2/spaces/{space_id}/branches/{branch_id}/objects/{sha256}检查分支对象 - PUT
/v2/spaces/{space_id}/branches/{branch_id}/objects/{sha256}写入分支对象 - POST
/v2/spaces/{space_id}/branches/{branch_id}/rollback回滚到检查点
