{"Status":true,"Message":"","Response":{"post":{"postuid":"894ba64a-d96b-4127-b6b7-d0b5c7ceb178","tenantuid":"d8b744fc-2e70-4089-bb80-dd1d08f6c7b2","projectuid":"fc6490ac-7527-4f49-b06e-46f701280e85","title":"Feeds and Machine-Readable Formats","slug":"article/feeds-and-machine-readable-formats","html":"\u003Cp\u003EBesides the web pages readers see, every HelpGuides site publishes its content in formats that feed readers, search engines, AI tools and your own code can use. There\u0027s nothing to turn on: these URLs work on your site as soon as you publish.\u003C/p\u003E\u003Cp\u003EIn the examples below, replace \u003Ccode\u003Edocs.example.com\u003C/code\u003E with your own domain. Only published content is included.\u003C/p\u003E\u003Ctable border=\u00221\u0022 style=\u0022border-collapse: collapse; width: 100%;\u0022\u003E\u003Cthead\u003E\u003Ctr\u003E\u003Cth\u003EURL\u003C/th\u003E\u003Cth\u003EFormat\u003C/th\u003E\u003Cth\u003EUse it for\u003C/th\u003E\u003C/tr\u003E\u003C/thead\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Ccode\u003E/feed\u003C/code\u003E\u003C/td\u003E\u003Ctd\u003ERSS 2.0\u003C/td\u003E\u003Ctd\u003EFeed readers, email newsletters, automations\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Ccode\u003E/site.json\u003C/code\u003E\u003C/td\u003E\u003Ctd\u003EJSON Feed\u003C/td\u003E\u003Ctd\u003EListing your posts in your own website or app\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Ccode\u003E/sitemap.xml\u003C/code\u003E\u003C/td\u003E\u003Ctd\u003EXML sitemap\u003C/td\u003E\u003Ctd\u003ESearch engines\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Ccode\u003E/robots.txt\u003C/code\u003E\u003C/td\u003E\u003Ctd\u003EText\u003C/td\u003E\u003Ctd\u003ETelling crawlers what they may index\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Ccode\u003E/llms.txt\u003C/code\u003E, \u003Ccode\u003E/llms-full.txt\u003C/code\u003E\u003C/td\u003E\u003Ctd\u003EMarkdown\u003C/td\u003E\u003Ctd\u003EAI tools and large language models\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Ccode\u003E{article}.md\u003C/code\u003E\u003C/td\u003E\u003Ctd\u003EMarkdown\u003C/td\u003E\u003Ctd\u003EOne article as Markdown\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Ccode\u003E{article}.html\u003C/code\u003E\u003C/td\u003E\u003Ctd\u003EHTML\u003C/td\u003E\u003Ctd\u003EOne article\u0027s content without your site\u0027s header, menu or footer\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Ccode\u003E/openapi.json\u003C/code\u003E\u003C/td\u003E\u003Ctd\u003EOpenAPI\u003C/td\u003E\u003Ctd\u003EDescribing the public API to AI platforms and developer tools\u003C/td\u003E\u003C/tr\u003E\u003C/table\u003E\u003Ch2 id=\u0022rss_feed\u0022\u003ERSS feed\u003C/h2\u003E\u003Cp\u003EYour RSS feed lists your published articles, newest first:\u003C/p\u003E\u003Cdiv class=\u0022code_wrapper\u0022\u003E\u003Cdiv class=\u0022code\u0022 data-language=\u0022plaintext\u0022\u003Ehttps://docs.example.com/feed\u003C/div\u003E\u003C/div\u003E\u003Cp\u003EEach item has the article\u0027s title, link, ID, meta description, publish date and last updated date. If the article has a featured image, it\u0027s included as a Media RSS image, which most feed readers display. Every page on your site links to the feed, so feed readers can find it automatically.\u003C/p\u003E\u003Ctable border=\u00221\u0022 style=\u0022border-collapse: collapse; width: 100%;\u0022\u003E\u003Cthead\u003E\u003Ctr\u003E\u003Cth\u003EParameter\u003C/th\u003E\u003Cth\u003EDefault\u003C/th\u003E\u003Cth\u003EDescription\u003C/th\u003E\u003C/tr\u003E\u003C/thead\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Ccode\u003Epage\u003C/code\u003E\u003C/td\u003E\u003Ctd\u003E1\u003C/td\u003E\u003Ctd\u003EWhich page of results to return\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Ccode\u003EpageSize\u003C/code\u003E\u003C/td\u003E\u003Ctd\u003E25\u003C/td\u003E\u003Ctd\u003EArticles per page, from 1 to 100\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Ccode\u003Ecategoryuid\u003C/code\u003E\u003C/td\u003E\u003Ctd\u003ENone\u003C/td\u003E\u003Ctd\u003EOnly include articles in this category\u003C/td\u003E\u003C/tr\u003E\u003C/table\u003E\u003Cdiv class=\u0022code_wrapper\u0022\u003E\u003Cdiv class=\u0022code\u0022 data-language=\u0022plaintext\u0022\u003Ehttps://docs.example.com/feed?pageSize=50\u0026amp;page=2\nhttps://docs.example.com/feed?categoryuid=dfecd3e0-896c-4032-b1c3-016d5dc47507\u003C/div\u003E\u003C/div\u003E\u003Cp\u003EThe feed is paged, so it doesn\u0027t return every article at once. It includes \u003Ccode\u003Eself\u003C/code\u003E, \u003Ccode\u003Efirst\u003C/code\u003E, \u003Ccode\u003Eprev\u003C/code\u003E, \u003Ccode\u003Enext\u003C/code\u003E and \u003Ccode\u003Elast\u003C/code\u003E links that feed readers use to page through it. A category\u0027s ID is the last part of its page URL, \u003Ccode\u003E/category/{id}\u003C/code\u003E.\u003C/p\u003E\u003Ch2 id=\u0022json_feed_sitejson\u0022\u003EJSON feed (site.json)\u003C/h2\u003E\u003Cp\u003E\u003Ccode\u003E/site.json\u003C/code\u003E returns your published articles as a JSON Feed, newest first. It\u0027s the easiest way to show a list of your latest articles or posts on another website.\u003C/p\u003E\u003Ctable border=\u00221\u0022 style=\u0022border-collapse: collapse; width: 100%;\u0022\u003E\u003Cthead\u003E\u003Ctr\u003E\u003Cth\u003EParameter\u003C/th\u003E\u003Cth\u003EDefault\u003C/th\u003E\u003Cth\u003EDescription\u003C/th\u003E\u003C/tr\u003E\u003C/thead\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Ccode\u003Epage\u003C/code\u003E\u003C/td\u003E\u003Ctd\u003E1\u003C/td\u003E\u003Ctd\u003EWhich page of results to return\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Ccode\u003EpageSize\u003C/code\u003E\u003C/td\u003E\u003Ctd\u003E12\u003C/td\u003E\u003Ctd\u003EArticles per page, from 1 to 50\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Ccode\u003Ecategoryuid\u003C/code\u003E\u003C/td\u003E\u003Ctd\u003ENone\u003C/td\u003E\u003Ctd\u003EOnly include articles in this category\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Ccode\u003Eauthoruid\u003C/code\u003E\u003C/td\u003E\u003Ctd\u003ENone\u003C/td\u003E\u003Ctd\u003EOnly include articles by this author\u003C/td\u003E\u003C/tr\u003E\u003C/table\u003E\u003Cdiv class=\u0022code_wrapper\u0022\u003E\u003Cdiv class=\u0022code\u0022 data-language=\u0022json\u0022\u003E{\n  \u0026quot;version\u0026quot;: \u0026quot;https://jsonfeed.org/version/1\u0026quot;,\n  \u0026quot;title\u0026quot;: \u0026quot;Example Docs\u0026quot;,\n  \u0026quot;home_page_url\u0026quot;: \u0026quot;https://docs.example.com\u0026quot;,\n  \u0026quot;feed_url\u0026quot;: \u0026quot;https://docs.example.com/site.json\u0026quot;,\n  \u0026quot;description\u0026quot;: \u0026quot;Welcome to the Example help center.\u0026quot;,\n  \u0026quot;total_items\u0026quot;: 42,\n  \u0026quot;page\u0026quot;: 1,\n  \u0026quot;page_size\u0026quot;: 12,\n  \u0026quot;total_pages\u0026quot;: 4,\n  \u0026quot;items\u0026quot;: [\n    {\n      \u0026quot;id\u0026quot;: \u0026quot;2377b2ce-464c-4a29-860c-66e5a75c4577\u0026quot;,\n      \u0026quot;title\u0026quot;: \u0026quot;Getting Started\u0026quot;,\n      \u0026quot;url\u0026quot;: \u0026quot;https://docs.example.com/article/getting-started\u0026quot;,\n      \u0026quot;excerpt\u0026quot;: \u0026quot;How to set up your account.\u0026quot;,\n      \u0026quot;published_date\u0026quot;: \u0026quot;2026-09-01T14:00:00\u0026quot;,\n      \u0026quot;date_updated\u0026quot;: \u0026quot;2026-09-20T09:30:00\u0026quot;,\n      \u0026quot;thumbnail_url\u0026quot;: \u0026quot;https://cdn.example.com/getting-started.png\u0026quot;,\n      \u0026quot;keywords\u0026quot;: \u0026quot;getting started; account setup\u0026quot;\n    }\n  ]\n}\u003C/div\u003E\u003C/div\u003E\u003Cp\u003EThe feed\u0027s title and description come from your project\u0027s \u003Cb\u003ETitle\u003C/b\u003E and \u003Cb\u003EWelcome Message\u003C/b\u003E in \u003Cb\u003ESettings\u003C/b\u003E. \u003Ccode\u003Ethumbnail_url\u003C/code\u003E is left out for articles without a featured image. Responses are cached for up to 5 minutes.\u003C/p\u003E\u003Ch2 id=\u0022markdown_and_plain_html_versions_of_an_article\u0022\u003EMarkdown and plain HTML versions of an article\u003C/h2\u003E\u003Cp\u003EAdd \u003Ccode\u003E.md\u003C/code\u003E or \u003Ccode\u003E.html\u003C/code\u003E to the end of any article\u0027s URL:\u003C/p\u003E\u003Cdiv class=\u0022code_wrapper\u0022\u003E\u003Cdiv class=\u0022code\u0022 data-language=\u0022plaintext\u0022\u003Ehttps://docs.example.com/article/getting-started.md\nhttps://docs.example.com/article/getting-started.html\u003C/div\u003E\u003C/div\u003E\u003Cul\u003E\u003Cli\u003E\u003Ccode\u003E.md\u003C/code\u003E returns the article as Markdown, which uses far fewer tokens than HTML when you give it to an AI model. See \u003Ca href=\u0022/article/viewing-in-markdown\u0022\u003EViewing in Markdown\u003C/a\u003E.\u003C/li\u003E\u003Cli\u003E\u003Ccode\u003E.html\u003C/code\u003E returns only the article\u0027s title and content as HTML, without your site\u0027s header, navigation, footer, scripts or styles. Use it to embed or import an article elsewhere.\u003C/li\u003E\u003C/ul\u003E\u003Cp\u003EBoth work for published and unlisted articles. Other articles show the 404 page.\u003C/p\u003E\u003Ch2 id=\u0022llmstxt_and_llmsfulltxt\u0022\u003Ellms.txt and llms-full.txt\u003C/h2\u003E\u003Cp\u003E\u003Ccode\u003E/llms.txt\u003C/code\u003E is a short index of your site for AI tools, listing your highlighted articles with their descriptions. \u003Ccode\u003E/llms-full.txt\u003C/code\u003E contains the full text of every published article in Markdown, in one file. It\u0027s rebuilt at most every 3 hours. See \u003Ca href=\u0022/article/using-llmstxt\u0022\u003EUsing LLMS.txt\u003C/a\u003E.\u003C/p\u003E\u003Ch2 id=\u0022robotstxt\u0022\u003Erobots.txt\u003C/h2\u003E\u003Cp\u003EHelpGuides generates \u003Ccode\u003E/robots.txt\u003C/code\u003E from your \u003Cb\u003EAllow Search Engine Indexing\u003C/b\u003E setting in \u003Cb\u003ESettings\u003C/b\u003E \u2192 \u003Cb\u003EGeneral\u003C/b\u003E. When indexing is allowed, it looks like this:\u003C/p\u003E\u003Cdiv class=\u0022code_wrapper\u0022\u003E\u003Cdiv class=\u0022code\u0022 data-language=\u0022plaintext\u0022\u003EUser-agent: *\nDisallow: /*.md$\nDisallow: /llms-full.txt\nSitemap: https://docs.example.com/sitemap.xml\u003C/div\u003E\u003C/div\u003E\u003Cp\u003EThe Markdown versions and \u003Ccode\u003Ellms-full.txt\u003C/code\u003E are disallowed so search engines don\u0027t index the same content twice. When indexing is turned off, every page is disallowed:\u003C/p\u003E\u003Cdiv class=\u0022code_wrapper\u0022\u003E\u003Cdiv class=\u0022code\u0022 data-language=\u0022plaintext\u0022\u003EUser-agent: *\nDisallow: /\u003C/div\u003E\u003C/div\u003E\u003Cp\u003E\u003Ccode\u003Erobots.txt\u003C/code\u003E is cached for up to 3 hours, so a change to the setting can take that long to appear. See \u003Ca href=\u0022/article/finding-broken-links-with-the-seo-report\u0022\u003EFinding Broken Links with the SEO Report\u003C/a\u003E for the indexing settings and \u003Ca href=\u0022/article/site-map\u0022\u003ESite Map\u003C/a\u003E for \u003Ccode\u003Esitemap.xml\u003C/code\u003E.\u003C/p\u003E\u003Ch2 id=\u0022public_api\u0022\u003EPublic API\u003C/h2\u003E\u003Cp\u003EYour site also answers these read-only JSON endpoints. They need no API key and power your site\u0027s own search and navigation.\u003C/p\u003E\u003Ctable border=\u00221\u0022 style=\u0022border-collapse: collapse; width: 100%;\u0022\u003E\u003Cthead\u003E\u003Ctr\u003E\u003Cth\u003EEndpoint\u003C/th\u003E\u003Cth\u003EReturns\u003C/th\u003E\u003C/tr\u003E\u003C/thead\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Ccode\u003EGET /api/v1/public/search?s={query}\u003C/code\u003E\u003C/td\u003E\u003Ctd\u003EUp to 10 search results. Add \u003Ccode\u003E\u0026amp;article_only=true\u003C/code\u003E to return one result per article\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Ccode\u003EGET /api/v1/public/search/stream?s={query}\u003C/code\u003E\u003C/td\u003E\u003Ctd\u003EThe same search as a stream of server-sent events, including an AI-generated answer for questions\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Ccode\u003EGET /api/v1/public/menu\u003C/code\u003E\u003C/td\u003E\u003Ctd\u003EYour category and article tree, published articles only\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Ccode\u003EGET /api/v1/public/posts/recent?count={n}\u003C/code\u003E\u003C/td\u003E\u003Ctd\u003EThe most recently published articles. \u003Ccode\u003Ecount\u003C/code\u003E is 1 to 20, default 5\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Ccode\u003EGET /api/v1/public/post/{postuid}/related\u003C/code\u003E\u003C/td\u003E\u003Ctd\u003EUp to 3 related articles\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Ccode\u003EGET /api/v1/public/post/{postuid}\u003C/code\u003E\u003C/td\u003E\u003Ctd\u003EOne article, including its HTML\u003C/td\u003E\u003C/tr\u003E\u003C/table\u003E\u003Cp\u003E\u003Ccode\u003E/openapi.json\u003C/code\u003E describes these endpoints. See \u003Ca href=\u0022/article/exposing-your-help-api-with-openapijson\u0022\u003EExposing Your APIs with openapi.json\u003C/a\u003E. To create, update or publish content from your own code, use the authenticated API with an API key from \u003Cb\u003ESettings\u003C/b\u003E \u2192 \u003Cb\u003EAPI Keys\u003C/b\u003E, or connect an AI assistant with \u003Ca href=\u0022/article/model-context-protocol\u0022\u003EModel Context Protocol\u003C/a\u003E.\u003C/p\u003E\u003Ch2 id=\u0022related_articles\u0022\u003ERelated articles\u003C/h2\u003E\u003Cul\u003E\u003Cli\u003E\u003Ca href=\u0022/article/using-llmstxt\u0022\u003EUsing LLMS.txt\u003C/a\u003E\u003C/li\u003E\u003Cli\u003E\u003Ca href=\u0022/article/viewing-in-markdown\u0022\u003EViewing in Markdown\u003C/a\u003E\u003C/li\u003E\u003Cli\u003E\u003Ca href=\u0022/article/site-map\u0022\u003ESite Map\u003C/a\u003E\u003C/li\u003E\u003Cli\u003E\u003Ca href=\u0022/article/structured-data\u0022\u003EStructured Data\u003C/a\u003E\u003C/li\u003E\u003Cli\u003E\u003Ca href=\u0022/article/exposing-your-help-api-with-openapijson\u0022\u003EExposing Your APIs with openapi.json\u003C/a\u003E\u003C/li\u003E\u003Cli\u003E\u003Ca href=\u0022/article/model-context-protocol\u0022\u003EModel Context Protocol\u003C/a\u003E\u003C/li\u003E\u003Cli\u003E\u003Ca href=\u0022/article/blog-projects\u0022\u003EBlog Projects\u003C/a\u003E\u003C/li\u003E\u003C/ul\u003E","publish_status":0,"post_type":"Article","authoruid":"3dde8c16-763a-4a2b-ae0b-1d8c50c62e3d","author":{"authoruid":"3dde8c16-763a-4a2b-ae0b-1d8c50c62e3d"},"featured_image_updating":false,"meta_description":"Publish your HelpGuides site content in multiple formats\u2014RSS, JSON, Markdown, HTML, and APIs\u2014to support feed readers, search engines, AI tools, and custom integrations.","display_toc":true,"has_workingcopy":false,"allow_indexing":true,"total_views":0,"date_published":"2026-10-04T21:50:10.333","date_updated":"2026-10-04T21:50:11.083","date_created":"2026-09-28T16:29:51.143"}}}