Framekeep-Entwickler
Öffentliche API-, OpenAPI- und MCP-Ressourcen.
Framekeep stellt eine kleine, versionierte, schreibgeschützte API für die öffentliche Produkterkennung bereit. Es erfordert keinen API-Schlüssel, gibt typisiertes JSON zurück, kündigt den Ratenbegrenzungsstatus an und gibt niemals Galerie-, Client-, Konto- oder Token-tragende Daten zurück. Für Agent-Hosts stehen die gleichen sicheren öffentlichen Fakten wie MCP-Tools zur Verfügung.
Schnellstart
Beginnen Sie mit dem API-Index und verwenden Sie dann die OpenAPI-Beschreibung als maßgeblichen sprachneutralen Vertrag.
curl https://framekeep.com/api/v1
curl https://framekeep.com/api/v1/product
curl https://framekeep.com/openapi.jsonStabile v1-Endpunkte
| Methode | Pfad | Zweck |
|---|---|---|
| GET | /api/v1 | Entdecken Sie die stabile öffentliche API, Dokumentation und Agentenschnittstellen. |
| GET | /api/v1/health | Überprüfen Sie die Serviceverfügbarkeit mit einer kurzen getippten Antwort. |
| GET | /api/v1/product | Rufen Sie überprüfte Produktfakten und kanonische öffentliche Ressourcen ab. |
Fehler und Ratenbeschränkungen
Dokumentierte API-Fehler verwenden RFC 9457-Problemdetails mit einem stabilen Code, einem lesbaren Detail und einem konkreten Lösungshinweis. Unbekannte API-Routen geben dieselbe JSON-Form anstelle einer HTML-Seite zurück. Antworten veröffentlichen aktuelle IETF-RateLimit-Felder sowie Kompatibilitätslimit-, verbleibende und zurückgesetzte Header. a 429 beinhaltet auch 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."
}Authentifizierung und Berechtigungen
Öffentliche v1-Endpunkte und MCP-Tools verwenden die Berechtigung public:read und erfordern keine Anmeldeinformationen. Private Galerie-Links und Studiositzungen sind von diesem öffentlichen Vertrag getrennt. Framekeep stellt keine OAuth-Tokens oder autonomen API-Schlüssel aus und Agenten dürfen niemals Anmeldeinformationen erfinden oder eine private URL außerhalb der genauen vom Benutzer autorisierten Aufgabe wiederverwenden.
- öffentlich:lesen
- Lesen Sie die öffentliche Zero-Auth-API und die öffentlichen MCP-Tools.
- Galerie:Kunde:lesen
- Sehen Sie sich eine private Galerie über den Link zur Clientfunktion an.
- Galerie:Bearbeiten:Schreiben
- Ändern Sie eine Galerie über den Link zur Bearbeitungsfunktion nach ausdrücklicher Genehmigung des Benutzers.
- studio:admin
- Verwalten Sie ein Studio über eine sichere Sitzung, die von einem Menschen eingerichtet wird.
Versionierung und Veraltung
Stabile REST-Vorgänge verwenden eine Hauptversion in der URL, beginnend mit /api/v1. Abwärtskompatible Antwortfelder können in Version 1 hinzugefügt werden. Eine bahnbrechende Anforderungs- oder Antwortänderung erfordert einen neuen Hauptpfad. Bevor eine stabile Version entfernt wird, kündigt Framekeep die Migration mindestens 90 Tage im Voraus an und gibt RFC 9745 Deprecation, einen datierten Sunset-Header und einen Link-Header der Nachfolgeversion zurück.
Es gibt keine separate Sandbox, da die öffentlichen Endpunkte null-authentifiziert und schreibgeschützt sind und keine Benutzerdaten enthalten. Die Galerieerstellung und jede private Funktions-URL bleiben Produktionsaktionen außerhalb dieser öffentlichen API und erfordern eine ausdrückliche Benutzergenehmigung.
MCP- und Agentenerkennung
Verbinden Sie einen Streamable HTTP MCP-Client mit dem öffentlichen Endpunkt unten. Die Tools sind schreibgeschützt und geben eine Framekeep-Übersicht, kanonische öffentliche Ressourcen und sichere Startoptionen zurück. Kein Tool akzeptiert ein Galerie-Token, ein Passwort, eine Sitzung oder eine Client-ID.
https://framekeep.com/mcp