API documentation & release communication
Publish your OpenAPI or Markdown files as hosted docs with version history. Review detected API changes, approve the release note and keep clients informed by email.
$6.99/month per workspace · For developers, agencies and small API teams
POST /payments
The currency request field is now required.
GET /refunds
A new endpoint to list refunds.
Send the currency field with each payment request. You can also use the new refunds endpoint to retrieve refunds.
Bring your existing docs. Publish from CI or upload a file.
01 / DOCUMENTATION YOUR CLIENTS CAN USE
Share a hosted documentation link with your clients. They can find an endpoint, understand its inputs and see the expected response, without asking you to send the latest file.
Upload JSON or YAML to generate searchable endpoint documentation with request parameters, response schemas, authentication details, examples and code samples from your spec.
Clients can link directly to an operation and return to the current version as your API evolves.
Upload a UTF-8 Markdown document for readable, hosted documentation with version history and source comparisons.
Markdown updates are recorded as document changes. Breaking-change detection uses the structured contract in an OpenAPI spec.
02 / BREAKING CHANGES & VERSION COMPARISONS
When you publish an OpenAPI version, APIRecap compares it with the version previously marked as latest. Removed operations, new required request fields and removed response fields are examples of changes flagged as breaking.
Use the detected facts and source comparison to decide what clients need to know. Checks describe changes in your spec; your team adds the business context and migration advice.
Spot a removed endpoint or a newly required parameter before you write the client announcement. Breaking changes are called out separately from additions and changes needing review.
Compare adjacent retained versions to see the lines that changed in your JSON, YAML or Markdown. Check the detail behind a release summary.
New versions don’t overwrite retained documents. Each has its own URL, so you can refer back to the documentation for an earlier release.
Publish a new version or select a retained one as latest. The current documentation link follows that selection, without sending clients a replacement link.
03 / FROM YOUR DEPLOYMENT TO YOUR CLIENT’S INBOX
Add publishing to your successful deployment workflow. Your docs update automatically, and your team controls the release message that follows.
Use a personal publishing key to send your document from CI. APIRecap saves a new version and updates the current docs as soon as publishing succeeds. See the API request and setup guide ↗
APIRecap uses detected changes to suggest a note. An Owner or Editor checks it, edits the wording and adds any migration guidance. The draft stays private until you approve it.
Approval makes the note visible to readers and triggers an email to confirmed subscribers who still have access. Clients can follow updates from the shared page, without you maintaining a separate mailing list.
Prefer a manual upload? Upload in the web app and review the changes and release note before publishing. Both routes keep the document and its release note together.
04 / BUILT FOR CLIENT WORK
For a freelancer handing over an integration, an agency managing several clients, or a small team supporting API customers: organise the docs around the people who use them.
See what’s includedKeep multiple APIs under one project, add a project logo, and give clients a shared place to find listed APIs and their release timeline.
Project links open listed APIs; separate API links open unlisted APIs. Private APIs require signed-in team access. Anyone with a valid share link can open it or forward it. Owners can revoke links or restrict external readers to the latest version.
See which shared documentation pages are opened and when. Page-open counts identify the link used, rather than the individual reader.
Editors help publish and approve notes. Signed-in Readers see only projects granted by the Owner. Team activity keeps a record of who changed what.
SIMPLE PRICING
Bring your client projects and your team into one workspace for $6.99/month. Hosted documentation, OpenAPI change detection, approved release notes and subscriber emails are included.
USD per workspace, plus applicable taxes. Built for teams that publish APIs for clients.
Included in the workspace plan
Monthly allowances apply per calendar month (UTC). Need more capacity? Contact us before exceeding an allowance.
EARLY ACCESS
Join the waitlist. We'll email you when APIRecap opens for your team.