Sweep · OpenAPI Overlay 1.0.0

API Evangelist enhancements for the Sweep API

3 actions 3 updates servers extends openapi/sweep-api-openapi.yml
Derived by API Evangelist Built from the contracts Sweep publishes. Sweep did not publish this file.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-providerx-apievangelist-harvested-fromx-apievangelist-harvestedcontacttermsOfServiceserversx-apievangelist-contract-gaps

Targets 2

$.info
$

OpenAPI Overlay

Raw ↑
overlay: 1.0.0
info:
  title: API Evangelist enhancements for the Sweep API
  version: 1.0.0
extends: openapi/sweep-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-provider: sweep
    x-apievangelist-harvested-from: https://api.sweep.io/api-json
    x-apievangelist-harvested: '2026-08-14'
    contact:
      name: Sweep
      url: https://www.sweep.io/contact
    termsOfService: https://www.sweep.io/terms
- target: $
  update:
    servers:
    - url: https://api.sweep.io
      description: Sweep production API — the host this document is served from
  x-note: 'The published document declares servers: [] (empty). This action supplies the host the document
    was fetched from and where /health responds; the original harvest in openapi/_original/ is left untouched.'
- target: $
  update:
    x-apievangelist-contract-gaps:
      operation_summaries: 50 of 698 operations carry a summary; 0 carry a description
      error_responses: 0 operations declare any 4xx or 5xx response — only 200/201/202 are described
      examples: no request or response examples in the document
      tags_declared: tags[] at the document root is empty although 69 distinct tag names are used on operations
      rate_limiting: no 429 described and no rate-limit headers documented
      idempotency: no idempotency key contract
  x-note: Recorded so the gaps travel with the artifact; the scorer parses the original document, so this
    does not alter the content score.

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/sweep-api-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.