{"Status":true,"Message":"","Response":{"post":{"postuid":"2f6d0e26-7218-45fc-aaa5-56929902ea01","tenantuid":"d8b744fc-2e70-4089-bb80-dd1d08f6c7b2","projectuid":"fc6490ac-7527-4f49-b06e-46f701280e85","title":"Exposing Your APIs with openapi.json","slug":"article/exposing-your-help-api-with-openapijson","html":"\u003Cp\u003ETo make your documentation content accessible to AI tools, search engines, and developer platforms like Microsoft Copilot, it\u0027s helpful to provide a machine-readable API specification using the \u003Ccode\u003Eopenapi.json\u003C/code\u003E format. This allows external systems to understand how to interact with your help content programmatically.\u003C/p\u003E\u003Ch2 id=\u0022what_is_openapijson\u0022\u003EWhat is openapi.json?\u003C/h2\u003E\u003Cp\u003E\u003Ccode\u003Eopenapi.json\u003C/code\u003E is a standard file based on the OpenAPI Specification that describes an API\u0027s endpoints, parameters and responses in a structured JSON format. It\u0027s widely supported by developer tools, SDK generators and AI platforms.\u003C/p\u003E\u003Ch2 id=\u0022why_publish_an_openapijson_file\u0022\u003EWhy Publish an openapi.json File?\u003C/h2\u003E\u003Cul\u003E\u003Cli\u003ELets Microsoft Copilot, ChatGPT and other AI tools search your help content\u003C/li\u003E\u003Cli\u003EHelps developer tools generate clients automatically\u003C/li\u003E\u003Cli\u003EGives third-party systems a clear way to query your documentation\u003C/li\u003E\u003Cli\u003EComplements your \u003Ca href=\u0022/article/supporting-ai-crawlers-with-aitxt\u0022\u003Eai.txt\u003C/a\u003E file for AI crawler support\u003C/li\u003E\u003C/ul\u003E\u003Ch2 id=\u0022helpguides_support_for_openapijson\u0022\u003EHelpGuides Support for openapi.json\u003C/h2\u003E\u003Cp\u003EHelpGuides generates an \u003Ccode\u003Eopenapi.json\u003C/code\u003E file for your site automatically. It describes your site\u0027s public search API, so AI platforms and other tools can search your published articles. It\u0027s at the root of your site. For example:\u003C/p\u003E\u003Cp\u003E\u003Ca href=\u0022https://docs.helpguides.io/openapi.json\u0022\u003Ehttps://docs.helpguides.io/openapi.json\u003C/a\u003E\u003C/p\u003E\u003Ch2 id=\u0022the_search_api\u0022\u003EThe search API\u003C/h2\u003E\u003Cp\u003EThe API has one endpoint. It needs no authentication and only returns published articles.\u003C/p\u003E\u003Cdiv class=\u0022code_wrapper\u0022\u003E\u003Cdiv class=\u0022code\u0022 data-language=\u0022text\u0022\u003EGET https://YOUR-DOMAIN/api/v1/public/search?s=reset%20password\u003C/div\u003E\u003C/div\u003E\u003Ctable border=\u00221\u0022 style=\u0022border-collapse: collapse; width: 100%;\u0022\u003E\u003Cthead\u003E\u003Ctr\u003E\u003Cth\u003EParameter\u003C/th\u003E\u003Cth\u003ERequired\u003C/th\u003E\u003Cth\u003EDescription\u003C/th\u003E\u003C/tr\u003E\u003C/thead\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Ccode\u003Es\u003C/code\u003E\u003C/td\u003E\u003Ctd\u003EYes\u003C/td\u003E\u003Ctd\u003EWhat to search for. Start with \u003Ccode\u003Ekeyword:\u003C/code\u003E to match exact words instead of meaning.\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Ccode\u003Earticle_only\u003C/code\u003E\u003C/td\u003E\u003Ctd\u003ENo\u003C/td\u003E\u003Ctd\u003E\u003Ccode\u003Etrue\u003C/code\u003E to return each article once. By default, results are sections of articles, so an article can appear more than once.\u003C/td\u003E\u003C/tr\u003E\u003C/table\u003E\u003Cp\u003EIt returns up to 10 results. Each has the article\u0027s postuid, title, slug, status, the matching section and its anchor, the section\u0027s content, an excerpt with matches highlighted, and the date it was last updated:\u003C/p\u003E\u003Cdiv class=\u0022code_wrapper\u0022\u003E\u003Cdiv class=\u0022code\u0022 data-language=\u0022json\u0022\u003E{\n  \u0026quot;results\u0026quot;: {\n    \u0026quot;posts\u0026quot;: [\n      {\n        \u0026quot;postuid\u0026quot;: \u0026quot;a19f3448-66a3-41ce-a2e1-dcc001551152\u0026quot;,\n        \u0026quot;title\u0026quot;: \u0026quot;Add Claude as an MCP Connector\u0026quot;,\n        \u0026quot;slug\u0026quot;: \u0026quot;article/adding-helpguides-to-claude-as-an-mcp-connector\u0026quot;,\n        \u0026quot;status\u0026quot;: \u0026quot;Published\u0026quot;,\n        \u0026quot;content\u0026quot;: \u0026quot;Your MCP URL is unique to your HelpGuides project...\u0026quot;,\n        \u0026quot;date_updated\u0026quot;: \u0026quot;2026-08-12T17:35:58.707\u002B00:00\u0026quot;,\n        \u0026quot;section\u0026quot;: \u0026quot;Finding your MCP URL\u0026quot;,\n        \u0026quot;section_anchor\u0026quot;: \u0026quot;#finding_your_mcp_url\u0026quot;,\n        \u0026quot;excerpt\u0026quot;: \u0026quot;Your \u0026lt;em\u0026gt;MCP\u0026lt;/em\u0026gt; URL is unique to your HelpGuides project...\u0026quot;\n      }\n    ],\n    \u0026quot;answer\u0026quot;: \u0026quot;\u0026quot;,\n    \u0026quot;is_answered\u0026quot;: false,\n    \u0026quot;is_streaming\u0026quot;: false\n  }\n}\u003C/div\u003E\u003C/div\u003E\u003Cp\u003EThis endpoint returns articles only; it doesn\u0027t write an AI answer. For answers, see \u003Ca href=\u0022/article/ai-answers-on-your-help-site\u0022\u003EAI Answers on Your Help Site\u003C/a\u003E. To let an AI assistant read and edit your documentation, see \u003Ca href=\u0022/article/model-context-protocol\u0022\u003EModel Context Protocol\u003C/a\u003E.\u003C/p\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":"Make your documentation accessible to AI tools and platforms by providing an openapi.json file\u2014a machine-readable API spec supported by HelpGuides.","display_toc":true,"has_workingcopy":false,"allow_indexing":true,"total_views":347,"date_published":"2025-06-04T15:59:00","date_updated":"2026-10-04T21:49:55.003","date_created":"2025-06-04T15:55:09.437"}}}