API documentation

Machine-readable interfaces exposed by Sumly AI Readiness.

OpenAPI descriptor

The full API surface is described in an OpenAPI 3.0 descriptor available at /openapi.json. It documents the check endpoint, report retrieval and the analysis service.

Model Context Protocol

A Model Context Protocol (MCP) manifest is served at /.well-known/mcp.json, enabling AI agents to discover and invoke Sumly tools and resources.

AI Actions manifest

An AI Actions manifest (ChatGPT plugin format) is served at /.well-known/ai-plugin.json for agent integration.

Getting started

Submit a check via GET /check?url=https://example.com (requires a human-verification token) or use the analysis endpoint directly. Read the OpenAPI descriptor for the complete reference.