Adyen makes documentation accessible to developers as well as the software and AI tools they create. To support this, we have implemented features that help you index and discover our documentation, read plain text versions of the pages, and receive updates about Adyen products and APIs.
Discover documentation
llms.txt
To help large language models (LLMs) discover and index our documentation, we provide a /llms.txt file. This file, located at the root of our documentation site, contains a list of all documentation pages grouped by their product category. It follows the proposed standard to help LLMs discover documentation. It is is similar to the sitemap file, but is specifically designed for consumption by AI and provides additional context.
This file allows you to easily get a list of all available documentation pages that you can then provide to your own custom AI models or tools, for example, to build a custom AI assistant that can answer questions about Adyen products.
You can access llms.txt at https://docs.adyen.com/llms.txt
Sitemap
A sitemap is a file where you can get a list of all the pages on the Adyen documentation website. You can use this to programmatically get a full list of all available documentation pages. While similar to the llms.txt file, the sitemap is a more general-purpose tool that can be used for a wide range of applications, including:
- Web scraping: You can use the sitemap to build a web scraper that fetches all our documentation pages.
- Search indexing: If you are building a search engine, you can use the sitemap to index all our documentation pages.
- Content discovery: You can use the sitemap to discover new content on our documentation site.
You can access the sitemap at: https://docs.adyen.com/sitemap
Access documentation
OpenAPI Specification
The Adyen OpenAPI Specification repository on GitHub contains OpenAPI specifications for every public API Adyen offers. These specifications are the single source of truth for our APIs and can be used to:
- Generate client libraries: You can use tools like OpenAPI Generator to generate client libraries in your preferred programming language. Adyen generates server-side libraries using a similar technique.
- Create Postman collections: The repository also includes Postman collections that you can import to start testing our APIs right away. Adyen provides Postman collections for some of our APIs that are also based on the OpenAPI specifications.
- Understand API functionality: The specifications provide a detailed, machine-readable description of every endpoint, including parameters, request and response bodies, and headers.
- Provide context to LLMs: The specification files can be used as valuable context to code assistants when working with Adyen APIs, especially when paired with Adyen MCP.
You can access the OpenAPI specifications at: https://github.com/Adyen/adyen-openapi
Markdown pages
Most pages on our documentation site can be rendered as a raw markdown file by simply appending .md to the URL. This provides a clean, machine-readable version of the content, stripped of all the website's navigation and styling.
This feature is particularly useful for:
- Feeding content into LLMs: You can fetch the raw markdown content of any page and use it as context for your AI models.
- Local development: You can easily download and use our documentation in your local development environment.
- Content analysis: You can programmatically analyze our documentation content.
For example, if you are viewing the webhooks documentation at:
https://docs.adyen.com/development-resources/webhooks
You can access the raw markdown version at:
https://docs.adyen.com/development-resources/webhooks.md
Get updates
Release notes
The release notes are the best way to stay up-to-date with the latest changes to Adyen products and APIs. We publish release notes for all our products, including APIs, libraries, and plugins. The release notes are grouped by product area, so you can easily find the information you need.
We recommend that you regularly check the release notes for the products you use to stay informed about new features, bug fixes, and other changes.
You can find all release notes at: https://docs.adyen.com/release-notes
RSS Feed
You can stay up to date with the latest changes by subscribing to our RSS feeds. RSS feeds provide a way to get updates from a website in a standardized, computer-readable format. You can use an RSS reader to subscribe to these feeds and get notified of new content.
For example, you can subscribe to the RSS feed for plugin release notes to get notified of new releases for our plugins.
We also provide release notes for other product areas. Check the specific release notes pages for those products for more information.