Saltar al contenido principal

Desarrolladores de Framekeep

Recursos API públicos, OpenAPI y MCP.

Framekeep expone una API pequeña, versionada y de solo lectura para el descubrimiento público de productos. No requiere clave API, devuelve JSON escrito, anuncia el estado del límite de velocidad y nunca devuelve datos de galería, cliente, cuenta o token. Los mismos datos públicos seguros están disponibles como herramientas MCP para los hosts de agentes.

Inicio rápido

Comience con el índice de API, luego use la descripción de OpenAPI como contrato autorizado y neutral en cuanto al idioma.

curl https://framekeep.com/api/v1
curl https://framekeep.com/api/v1/product
curl https://framekeep.com/openapi.json

Puntos finales estables v1

MétodoCaminoPropósito
OBTENER/api/v1Descubra la API pública estable, la documentación y las interfaces de agente.
OBTENER/api/v1/healthVerifique la disponibilidad del servicio con una pequeña respuesta escrita.
OBTENER/api/v1/productRecuperar datos de productos revisados ​​y recursos públicos canónicos.

Errores y límites de tarifas

Las fallas de API documentadas utilizan detalles del problema RFC 9457 con un código estable, un detalle legible y una sugerencia de resolución concreta. Las rutas API desconocidas devuelven la misma forma JSON en lugar de una página HTML. Las respuestas publican los campos IETF RateLimit actuales más el límite de compatibilidad, los encabezados restantes y de restablecimiento; un 429 también incluye Reintentar después.

{
  "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."
}

Autenticación y permisos

Los puntos finales públicos v1 y las herramientas MCP utilizan el permiso público: lectura y no requieren credenciales. Los enlaces de capacidad de galería privada y las sesiones de estudio son independientes de este contrato público. Framekeep no emite tokens OAuth ni claves API autónomas, y los agentes nunca deben inventar credenciales ni reutilizar una URL privada fuera de la tarea exacta autorizada por el usuario.

público:leer
Lea la API pública de autenticación cero y las herramientas públicas de MCP.
galería:cliente:leer
Vea una galería privada a través de su enlace de capacidad de cliente.
galería:editar:escribir
Modifique una galería a través de su enlace de capacidad de edición después de la aprobación explícita del usuario.
estudio: administrador
Administrar un estudio a través de una sesión segura establecida por un humano.

Control de versiones y desaprobación

Las operaciones REST estables utilizan una versión principal en la URL, que comienza con /api/v1. Se pueden agregar campos de respuesta compatibles con versiones anteriores dentro de v1. Una solicitud importante o un cambio de respuesta requiere un nuevo camino importante. Antes de que se elimine una versión estable, Framekeep anunciará la migración con al menos 90 días de anticipación y devolverá el RFC 9745 Deprecation, un encabezado Sunset con fecha y un encabezado Link de la versión sucesora.

No existe una zona de pruebas separada porque los puntos finales públicos tienen autenticación cero, son de solo lectura y no contienen datos de usuario. La creación de la galería y cada URL de capacidad privada siguen siendo acciones de producción fuera de esta API pública y requieren la aprobación explícita del usuario.

MCP y descubrimiento de agentes

Conecte un cliente HTTP MCP Streamable al punto final público a continuación. Las herramientas son de solo lectura y devuelven una descripción general de Framekeep, recursos públicos canónicos y opciones de inicio seguro. Ninguna herramienta acepta un token de galería, una contraseña, una sesión o un identificador de cliente.

https://framekeep.com/mcp

Enviar comentarios