Exposing Your APIs with openapi.json

To make your documentation content accessible to AI tools, search engines, and developer platforms like Microsoft Copilot, it's helpful to provide a machine-readable API specification using the openapi.json format. This allows external systems to understand how to interact with your help content programmatically.

What is openapi.json?

openapi.json is a standard file based on the OpenAPI Specification that describes your API's endpoints, parameters, responses, and data models in a structured JSON format. It’s widely supported by developer tools, SDK generators, and AI platforms.

Why Publish an openapi.json File?

• Enables integrations with Microsoft Copilot, ChatGPT, and other AI tools
• Helps developer tools automatically generate SDKs and clients
• Provides a clear structure for third-party systems to access your documentation
• Complements your ai.txt file for AI crawler support

HelpGuides Support for openapi.json

HelpGuides fully support openapi.json to describe APIs that AI platforms can consume.

You can find your openapi.json file in the root of your site. For example:

https://docs.dailystory.com/openapi.json