API Surface
Scan another siteWhat This Check Covers
Probes for OpenAPI/Swagger specs, GraphQL endpoint hints, and API doc links.
Frequently Asked Questions
- What is an API Surface?
- It's the publicly discoverable set of APIs (like REST endpoints or GraphQL) that a bot can interact with directly, instead of parsing HTML.
- Why expose API docs to bots?
- Advanced agents (like ChatGPT with browsing) can read OpenAPI specs and dynamically construct API calls to query your inventory in real-time.
Field Guide
| Field | Meaning |
|---|---|
spec_found |
Per known path, whether an API spec was validly discovered. |
probe_status |
Per probe result: found, not_found, or unknown. |
graphql_options_status |
HTTP status returned by OPTIONS /graphql probe. |
doc_links |
Homepage links that look like API/developer docs. |