Framekeep 开发者
公共 API、OpenAPI 和 MCP 资源。
Framekeep 公开了一个小型、版本化、只读 API，用于公共产品发现。它不需要 API 密钥，返回类型化 JSON，通告速率限制状态，并且从不返回图库、客户端、帐户或带有令牌的数据。相同的安全公共事实可用作代理主机的 MCP 工具。
快速入门
从API索引开始，然后使用OpenAPI描述作为权威的语言中立合约。
curl https://framekeep.com/api/v1
curl https://framekeep.com/api/v1/product
curl https://framekeep.com/openapi.json稳定的 v1 端点
| 方法 | 路径 | 目的 |
|---|---|---|
| 获取 | /api/v1 | 发现稳定的公共 API、文档和代理接口。 |
| 获取 | /api/v1/health | 通过小型键入响应检查服务可用性。 |
| 获取 | /api/v1/product | 检索经过审查的产品事实和规范的公共资源。 |
错误和速率限制
记录的 API 故障使用 RFC 9457 问题详细信息以及稳定的代码、可读的详细信息和具体的解决方案提示。未知的 API 路由返回相同的 JSON 形状而不是 HTML 页面。响应发布当前的 IETF RateLimit 字段以及兼容性限制、剩余和重置标头； 429 还包括 Retry-After。
{
"type": "https://framekeep.com/problems/api_route_not_found",
"title": "API route not found",
"status": 404,
"code": "api_route_not_found",
"detail": "The requested route is not part of the public contract.",
"resolution": "Use the OpenAPI description to recover."
}身份验证和权限
公共 v1 端点和 MCP 工具使用 public:read 权限，不需要凭据。私人画廊功能链接和工作室会议与此公共合同是分开的。 Framekeep 不颁发 OAuth 令牌或自主 API 密钥，代理绝不能在用户授权的任务之外发明凭证或重用私有 URL。
- 公众：阅读
- 阅读零身份验证公共 API 和公共 MCP 工具。
- 画廊：客户：阅读
- 通过客户端功能链接查看一个私人画廊。
- 画廊：编辑：写
- 在用户明确批准后，通过其编辑功能链接修改一个图库。
- 工作室：admin
- 通过人工建立的安全会话管理一个工作室。
版本控制和弃用
稳定的 REST 操作在 URL 中使用主要版本，以 /api/v1 开头。可以在 v1 中添加向后兼容的响应字段。中断请求或响应更改需要新的主路径。在删除稳定版本之前，Framekeep 将至少提前 90 天宣布迁移，并返回 RFC 9745 Deprecation、带日期的 Sunset 标头和后续版本的 Link 标头。
没有单独的沙箱，因为公共端点是零身份验证、只读且不包含用户数据。图库创建和每个私有功能 URL 仍然是此公共 API 之外的生产操作，并且需要明确的用户批准。