Framekeep developers
Public API, OpenAPI, and MCP resources.
Framekeep exposes a small, versioned, read-only API for public product discovery. It requires no API key, returns typed JSON, advertises rate-limit state, and never returns gallery, client, account, or token-bearing data. The same safe public facts are available as MCP tools for agent hosts.
Quickstart
Start with the API index, then use the OpenAPI description as the authoritative language-neutral contract.
curl https://framekeep.com/api/v1
curl https://framekeep.com/api/v1/product
curl https://framekeep.com/openapi.jsonStable v1 endpoints
| Method | Path | Purpose |
|---|---|---|
| GET | /api/v1 | Discover the stable public API, documentation, and agent interfaces. |
| GET | /api/v1/health | Check service availability with a small typed response. |
| GET | /api/v1/product | Retrieve reviewed product facts and canonical public resources. |
Errors and rate limits
Documented API failures use RFC 9457 problem details with a stable code, a readable detail, and a concrete resolution hint. Unknown API routes return the same JSON shape instead of an HTML page. Responses publish current IETF RateLimit fields plus compatibility limit, remaining, and reset headers; a 429 also includes 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."
}Authentication and permissions
Public v1 endpoints and MCP tools use the public:read permission and require no credentials. Private gallery capability links and studio sessions are separate from this public contract. Framekeep does not issue OAuth tokens or autonomous API keys, and agents must never invent credentials or reuse a private URL outside the exact user-authorized task.
- public:read
- Read the zero-auth public API and public MCP tools.
- gallery:client:read
- View one private gallery through its client capability link.
- gallery:edit:write
- Modify one gallery through its edit capability link after explicit user approval.
- studio:admin
- Administer one studio through a secure session established by a human.
Versioning and deprecation
Stable REST operations use a major version in the URL, beginning with /api/v1. Backward-compatible response fields may be added within v1. A breaking request or response change requires a new major path. Before a stable version is removed, Framekeep will announce the migration at least 90 days ahead and return RFC 9745 Deprecation, a dated Sunset header, and a successor-version Link header.
There is no separate sandbox because the public endpoints are zero-auth, read-only, and contain no user data. Gallery creation and every private capability URL remain production actions outside this public API and require explicit user approval.
MCP and agent discovery
Connect a Streamable HTTP MCP client to the public endpoint below. The tools are read-only and return a Framekeep overview, canonical public resources, and safe start options. No tool accepts a gallery token, password, session, or client identifier.
https://framekeep.com/mcp