{"title":"Documentation and knowledge tools","category":"default","creationDate":1779620072,"content":"<p>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.<\/p>\n<h2>Discover documentation<\/h2>\n<h3>llms.txt<\/h3>\n<p>To help large language models (LLMs) discover and index our documentation, we provide a <code>\/llms.txt<\/code> 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 <a href=\"https:\/\/llmstxt.org\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">proposed standard<\/a> to help LLMs discover documentation. It is is similar to the <code>sitemap<\/code> file, but is specifically designed for consumption by AI and provides additional context.<\/p>\n<p>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.<\/p>\n<p>You can access llms.txt at <code>https:\/\/docs.adyen.com\/llms.txt<\/code><\/p>\n<h3>Sitemap<\/h3>\n<p>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 <code>llms.txt<\/code> file, the sitemap is a more general-purpose tool that can be used for a wide range of applications, including:<\/p>\n<ul>\n<li><strong>Web scraping:<\/strong> You can use the sitemap to build a web scraper that fetches all our documentation pages.<\/li>\n<li><strong>Search indexing:<\/strong> If you are building a search engine, you can use the sitemap to index all our documentation pages.<\/li>\n<li><strong>Content discovery:<\/strong> You can use the sitemap to discover new content on our documentation site.<\/li>\n<\/ul>\n<p>You can access the sitemap at: <code>https:\/\/docs.adyen.com\/sitemap<\/code><\/p>\n<h2>Access documentation<\/h2>\n<h3>OpenAPI Specification<\/h3>\n<p>The Adyen OpenAPI Specification repository on GitHub contains <a href=\"https:\/\/www.openapis.org\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">OpenAPI specifications<\/a> for every public API Adyen offers. These specifications are the single source of truth for our APIs and can be used to:<\/p>\n<ul>\n<li><strong>Generate client libraries:<\/strong> You can use tools like <a href=\"https:\/\/openapi-generator.tech\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">OpenAPI Generator<\/a> to generate client libraries in your preferred programming language. Adyen generates <a href=\"https:\/\/docs.adyen.com\/development-resources\/libraries\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">server-side libraries<\/a> using a similar technique.<\/li>\n<li><strong>Create Postman collections:<\/strong> The repository also includes Postman collections that you can import to start testing our APIs right away. Adyen provides <a href=\"https:\/\/github.com\/Adyen\/adyen-postman\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Postman collections<\/a> for some of our APIs that are also based on the OpenAPI specifications.<\/li>\n<li><strong>Understand API functionality:<\/strong> The specifications provide a detailed, machine-readable description of every endpoint, including parameters, request and response bodies, and headers.<\/li>\n<li><strong>Provide context to LLMs:<\/strong> The specification files can be used as valuable context to code assistants when working with Adyen APIs, especially when paired with <a href=\"\/development-resources\/mcp-server\">Adyen MCP<\/a>.<\/li>\n<\/ul>\n<p>You can access the OpenAPI specifications at: <code>https:\/\/github.com\/Adyen\/adyen-openapi<\/code><\/p>\n<h3>Markdown pages<\/h3>\n<p>Most pages on our documentation site can be rendered as a raw markdown file by simply appending <code>.md<\/code> to the URL. This provides a clean, machine-readable version of the content, stripped of all the website's navigation and styling.<\/p>\n<p>This feature is particularly useful for:<\/p>\n<ul>\n<li><strong>Feeding content into LLMs:<\/strong> You can fetch the raw markdown content of any page and use it as context for your AI models.<\/li>\n<li><strong>Local development:<\/strong> You can easily download and use our documentation in your local development environment.<\/li>\n<li><strong>Content analysis:<\/strong> You can programmatically analyze our documentation content.<\/li>\n<\/ul>\n<p>For example, if you are viewing the webhooks documentation at:<br \/>\n<code>https:\/\/docs.adyen.com\/development-resources\/webhooks<\/code><\/p>\n<p>You can access the raw markdown version at:<br \/>\n<code>https:\/\/docs.adyen.com\/development-resources\/webhooks.md<\/code><\/p>\n<h2>Get updates<\/h2>\n<h3>Release notes<\/h3>\n<p>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.<\/p>\n<p>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.<\/p>\n<p>You can find all release notes at: <a href=\"https:\/\/docs.adyen.com\/release-notes\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">https:\/\/docs.adyen.com\/release-notes<\/a><\/p>\n<h3>RSS Feed<\/h3>\n<p>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.<\/p>\n<p>For example, you can subscribe to the RSS feed for plugin release notes to get notified of new releases for our plugins.<\/p>\n<ul>\n<li><a href=\"https:\/\/docs.adyen.com\/plugins\/release-notes.xml\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Plugin release notes RSS feed<\/a><\/li>\n<\/ul>\n<p>We also provide release notes for other product areas. Check the specific release notes pages for those products for more information.<\/p>\n<h2>See also<\/h2>\n<ul>\n<li><a href=\"https:\/\/www.adyen.com\/knowledge-hub\/improving-the-developer-experience-with-openapi-specification\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Improving the developer experience with OpenAPI Specification<\/a><\/li>\n<li><a href=\"https:\/\/www.adyen.com\/knowledge-hub\/how-adyen-does-ai\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">How Adyen does AI<\/a><\/li>\n<li><a href=\"https:\/\/www.adyen.com\/knowledge-hub\/adyen-api-libraries\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Building better applications with Adyen API Libraries<\/a><\/li>\n<li><a href=\"https:\/\/www.adyen.com\/the-latest\/introducing-the-mcp-server-a-smarter-way-to-build-with-adyen\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Introducing the MCP server: A smarter way to build with Adyen<\/a><\/li>\n<\/ul>","url":"https:\/\/docs.adyen.com\/development-resources\/documentation-tools","articleFields":{"description":"Discover, access, and get updates to Adyen documentation using AI and programmatic tools.","cache_enable":false,"feedback_component":true},"algolia":{"url":"https:\/\/docs.adyen.com\/development-resources\/documentation-tools","title":"Documentation and knowledge tools","content":"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.\nDiscover documentation\nllms.txt\nTo 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.\nThis 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.\nYou can access llms.txt at https:\/\/docs.adyen.com\/llms.txt\nSitemap\nA 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:\n\nWeb scraping: You can use the sitemap to build a web scraper that fetches all our documentation pages.\nSearch indexing: If you are building a search engine, you can use the sitemap to index all our documentation pages.\nContent discovery: You can use the sitemap to discover new content on our documentation site.\n\nYou can access the sitemap at: https:\/\/docs.adyen.com\/sitemap\nAccess documentation\nOpenAPI Specification\nThe 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:\n\nGenerate 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.\nCreate 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.\nUnderstand API functionality: The specifications provide a detailed, machine-readable description of every endpoint, including parameters, request and response bodies, and headers.\nProvide 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.\n\nYou can access the OpenAPI specifications at: https:\/\/github.com\/Adyen\/adyen-openapi\nMarkdown pages\nMost 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.\nThis feature is particularly useful for:\n\nFeeding content into LLMs: You can fetch the raw markdown content of any page and use it as context for your AI models.\nLocal development: You can easily download and use our documentation in your local development environment.\nContent analysis: You can programmatically analyze our documentation content.\n\nFor example, if you are viewing the webhooks documentation at:\nhttps:\/\/docs.adyen.com\/development-resources\/webhooks\nYou can access the raw markdown version at:\nhttps:\/\/docs.adyen.com\/development-resources\/webhooks.md\nGet updates\nRelease notes\nThe 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.\nWe recommend that you regularly check the release notes for the products you use to stay informed about new features, bug fixes, and other changes.\nYou can find all release notes at: https:\/\/docs.adyen.com\/release-notes\nRSS Feed\nYou 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.\nFor example, you can subscribe to the RSS feed for plugin release notes to get notified of new releases for our plugins.\n\nPlugin release notes RSS feed\n\nWe also provide release notes for other product areas. Check the specific release notes pages for those products for more information.\nSee also\n\nImproving the developer experience with OpenAPI Specification\nHow Adyen does AI\nBuilding better applications with Adyen API Libraries\nIntroducing the MCP server: A smarter way to build with Adyen\n","type":"page","locale":"en","boost":18,"hierarchy":{"lvl0":"Home","lvl1":"Development resources","lvl2":"Documentation and knowledge tools"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/","lvl1":"https:\/\/docs.adyen.com\/development-resources","lvl2":"\/development-resources\/documentation-tools"},"levels":3,"category":"Development Resources","category_color":"green","tags":["Documentation","knowledge","tools"]}}
