canonical: https://jentic.com/apis/framekeep.com/framekeep # Framekeep Public API The Framekeep Public API exposes a versioned, read-only discovery surface for Framekeep, returning the public API index of stable endpoints, a service health check, and the reviewed public product overview with canonical documentation links. It never returns gallery, account, or token-bearing data. The v1 contract is backward compatible, and deprecations are announced with Deprecation, Sunset, and successor-version Link headers before removal. ## For AI agents Read Framekeep's public API index of stable endpoints, check service health, and fetch the reviewed public product overview with documentation links. Read-only and public, with no gallery or account data exposed. ## Scope Does not expose galleries, accounts, tokens, or any mutating operation. Use for reading Framekeep's public API index, service health, and product metadata only. ## Capabilities - Retrieve the public API index of stable discovery endpoints and documentation links - Check Framekeep service health and read-only availability - Fetch the reviewed public product overview with canonical documentation links ## Use cases ### Agent Service Discovery An AI agent connected through Jentic can read Framekeep's public API index, confirm the service is healthy, and fetch the product overview before taking further action, without a developer wiring the Framekeep API by hand. Every operation is read-only and needs no credential. Example prompt: Fetch the public API index and confirm the service health status is healthy ### Health Monitoring Operators poll a lightweight endpoint to confirm a service is up. Framekeep's health check returns the current service status, and the index advertises the stable endpoints so a monitor knows what to watch. Example prompt: Poll the Framekeep health endpoint and record whether the service is healthy ### Product Metadata Lookup Catalog and directory tools display a product overview and its documentation links. Framekeep returns the reviewed public product overview, its review date, and canonical resource links as structured metadata. Example prompt: Fetch the public product overview and extract its documentation links ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | `/api/v1` | Get the public API index | | GET | `/api/v1/health` | Check service health | | GET | `/api/v1/product` | Get public product metadata | ## Key resources - **Discovery** — Retrieve the public API index of stable endpoints and documentation links - **Health** — Check the current service health status - **Product metadata** — Fetch the reviewed public product overview with canonical links ## AI readiness This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use. - **Score:** 74 / 100 - **Maturity:** AI-Aware - **Dimensions:** - Foundational Compliance: 100 / 100 - Developer Experience & Jentic Compatibility: 67 / 100 - AI-Readiness & Agent Experience: 68 / 100 - Agent Usability: 94 / 100 - Security: 50 / 100 - AI Discoverability: 88 / 100 - **View full report:** https://jentic.com/apis/framekeep.com/framekeep/scorecard - **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/ - **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview ### Score it yourself Every API in the directory is allowlisted, so you can re-score it with no key required. - **Score your own API:** https://jentic.com/scorecard.md - **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md ```sh npx @jentic/api-scorecard-cli score ``` ## Why Jentic - **Setup:** Wiring the Framekeep Public API by hand still means discovering its endpoints, reading the index, and handling its versioning and deprecation headers yourself. Through Jentic you install once, import Framekeep from the API Directory, and your agent calls its read-only operations with nothing to configure. - **Permission scoping:** Framekeep's public API is read-only with three operations, so a rule can allow only the index, health, and product reads. You choose the operations the agent may call, and because none of them write, its reach is limited to reading public metadata. - **Credential handling:** Framekeep's public endpoints need no credential, so there is nothing to store. When you connect a credentialed API through Jentic, its key is stored encrypted by your own Jentic One instance and injected at execution time, never entering the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'get the API index' or 'check service health', and Jentic returns the matching Framekeep operation with its output shape so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Better Stack** — Uptime monitoring that checks service health on your behalf. - **Statuspage** — Hosted status pages for communicating service health. - **Watchful** — Monitors APIs for changes and new versions. ## FAQ ### What authentication does the Framekeep Public API use? The Framekeep Public API is read-only and public: its discovery, health, and product endpoints need no credential, per its OpenAPI spec. The spec declares a studio session cookie, but that is a human browser session for studio administration and is not accepted by the public v1 endpoints. Through Jentic you import and call the public endpoints with no key to store. ### Can I check the Framekeep service health? Yes. The health operation returns the current service status, and the API index lists the stable public endpoints so a monitor knows what to poll. ### Can I limit what my agent is allowed to do with the Framekeep Public API? Yes. The public API is read-only with three operations, so a rule can allow only the index, health, and product-metadata reads, and because there are no write operations, the agent cannot change anything. Every call it makes is logged. ### Is there a Framekeep MCP server? You do not need an MCP server to give your agent the Framekeep Public API. Jentic connects it directly from the API Directory: import Framekeep, and the agent calls its read-only operations by intent without loading another server's tool definitions into its context. ### What are the rate limits for the Framekeep Public API? The Framekeep Public API returns standard IETF RateLimit headers describing the current quota and reset time, but the OpenAPI spec does not state a fixed numeric ceiling. Check the Framekeep documentation at https://framekeep.com for current limits. ### How do I read Framekeep product metadata through Jentic? Search Jentic for an intent like 'get product metadata', and it returns Framekeep's product operation with its output shape so your agent can read the overview and its documentation links. To run it on your own infrastructure, install Jentic One from its GitHub repo.