{"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\n\u003Ccode\u003Eopenapi.json\u003C/code\u003E is a standard file based on the OpenAPI Specification that describes your API\u0027s endpoints, parameters, responses, and data models in a structured JSON format. It\u2019s 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\u003EEnables integrations with Microsoft Copilot, ChatGPT, and other AI tools\n\u003C/li\u003E\u003Cli\u003EHelps developer tools automatically generate SDKs and clients\n\u003C/li\u003E\u003Cli\u003EProvides a clear structure for third-party systems to access your documentation\n\u003C/li\u003E\u003Cli\u003EComplements your \u003Ccode\u003Eai.txt\u003C/code\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 fully support \u003Ccode class=\u0022inline-code\u0022\u003Eopenapi.json\u003C/code\u003E\u0026nbsp;to describe APIs that AI platforms can consume.\u003C/p\u003E\u003Cp\u003EYou can find your \u003Ccode class=\u0022inline-code\u0022\u003Eopenapi.json\u003C/code\u003E\u0026nbsp;file in the root of your site. For example:\u003C/p\u003E\u003Cp\u003E\u003Ca href=\u0022https://docs.dailystory.com/ai.txt\u0022\u003E\u003C/a\u003E\u003Ca href=\u0022https://docs.dailystory.com/openapi.json\u0022\u003Ehttps://docs.dailystory.com/openapi.json\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":255,"date_published":"2025-06-04T15:59:52.557","date_updated":"2025-06-04T15:59:53.027","date_created":"2025-06-04T15:55:09.437"}}}