Développeurs Framekeep
Ressources API publiques, OpenAPI et MCP.
Framekeep expose une petite API versionnée en lecture seule pour la découverte de produits publics. Il ne nécessite aucune clé API, renvoie du JSON tapé, annonce l'état de limite de débit et ne renvoie jamais de données de galerie, de client, de compte ou de jeton. Les mêmes informations publiques sécurisées sont disponibles sous forme d'outils MCP pour les hôtes d'agent.
Démarrage rapide
Commencez par l'index de l'API, puis utilisez la description OpenAPI comme contrat faisant autorité, indépendant du langage.
curl https://framekeep.com/api/v1
curl https://framekeep.com/api/v1/product
curl https://framekeep.com/openapi.jsonPoints de terminaison v1 stables
| Méthode | Chemin | Objectif |
|---|---|---|
| OBTENIR | /api/v1 | Découvrez l'API publique stable, la documentation et les interfaces d'agent. |
| OBTENIR | /api/v1/health | Vérifiez la disponibilité du service avec une petite réponse dactylographiée. |
| OBTENIR | /api/v1/product | Récupérez les faits examinés sur les produits et les ressources publiques canoniques. |
Erreurs et limites de débit
Les échecs d'API documentés utilisent les détails du problème RFC 9457 avec un code stable, des détails lisibles et un indice de résolution concret. Les routes API inconnues renvoient la même forme JSON au lieu d'une page HTML. Les réponses publient les champs RateLimit IETF actuels ainsi que les en-têtes de limite de compatibilité, restants et de réinitialisation ; un 429 inclut également 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."
}Authentification et autorisations
Les points de terminaison publics v1 et les outils MCP utilisent l'autorisation public:read et ne nécessitent aucune information d'identification. Les liens vers les galeries privées et les sessions en studio sont distincts de ce contrat public. Framekeep n'émet pas de jetons OAuth ni de clés API autonomes, et les agents ne doivent jamais inventer d'informations d'identification ni réutiliser une URL privée en dehors de la tâche exacte autorisée par l'utilisateur.
- public :lire
- Lisez l'API publique sans authentification et les outils MCP publics.
- galerie:client:lire
- Affichez une galerie privée via son lien de fonctionnalité client.
- galerie : modifier : écrire
- Modifiez une galerie via son lien de capacité d'édition après l'approbation explicite de l'utilisateur.
- studio:administrateur
- Administrer un studio via une session sécurisée établie par un humain.
Gestion des versions et dépréciation
Les opérations REST stables utilisent une version majeure dans l'URL, commençant par /api/v1. Des champs de réponse rétrocompatibles peuvent être ajoutés dans la v1. Une demande de rupture ou un changement de réponse nécessite un nouveau chemin majeur. Avant qu'une version stable ne soit supprimée, Framekeep annoncera la migration au moins 90 jours à l'avance et renverra la dépréciation RFC 9745, un en-tête Sunset daté et un en-tête Link de la version successeur.
Il n'y a pas de bac à sable séparé car les points de terminaison publics sont sans authentification, en lecture seule et ne contiennent aucune donnée utilisateur. La création de galerie et chaque URL de fonctionnalité privée restent des actions de production en dehors de cette API publique et nécessitent l'approbation explicite de l'utilisateur.
MCP et découverte d'agents
Connectez un client HTTP MCP Streamable au point de terminaison public ci-dessous. Les outils sont en lecture seule et renvoient un aperçu de Framekeep, des ressources publiques canoniques et des options de démarrage sécurisé. Aucun outil n'accepte un jeton de galerie, un mot de passe, une session ou un identifiant client.
https://framekeep.com/mcp