diff --git a/optimize/feedback.mdx b/optimize/feedback.mdx index 4c6e2b072..3aff59bad 100644 --- a/optimize/feedback.mdx +++ b/optimize/feedback.mdx @@ -1,7 +1,7 @@ --- title: "Feedback" -description: "Monitor user satisfaction with built-in feedback widgets, page ratings, and thumbs up/down reactions to identify documentation improvement areas." -keywords: ["user feedback","thumbs rating","contextual feedback","satisfaction"] +description: "Monitor user satisfaction with built-in feedback widgets, page ratings, thumbs up/down reactions, and AI agent feedback to identify documentation improvement areas." +keywords: ["user feedback","thumbs rating","contextual feedback","satisfaction","AI agent feedback"] --- @@ -53,6 +53,7 @@ The feedback tab displays information according to the [feedback add-ons](https: - **Raise issues**: Allow users to create GitHub issues directly from your documentation. Only available for public GitHub repositories. - **Contextual feedback**: Free form feedback about the content of a page. - **Code snippet feedback**: Feedback specifically on code snippets. +- **AI agent feedback**: Feedback submitted by AI agents that read your documentation. See [AI agent feedback](#ai-agent-feedback) for details. ## Collect email addresses @@ -101,6 +102,45 @@ Click a piece of feedback to add an internal note. These notes are only visible Use notes to add information for collaboration, link relevant support or engineering tickets, or remember any other useful information. +## AI agent feedback + +AI agents like Claude, ChatGPT, Copilot, and others can submit feedback about your documentation pages through a public API endpoint. This feedback is collected separately from user feedback and helps you understand how AI tools interact with your content. + +When an AI agent reads a page of your documentation, it can report whether the page was helpful and provide optional written feedback. Mintlify automatically identifies the AI agent from its request headers and records the agent name alongside the feedback. + +### How it works + +AI agents submit feedback by sending a `POST` request to your documentation site's feedback endpoint. The request requires the domain of your documentation site, the page path, and a `helpful` boolean rating. An optional `feedback` string provides additional context. + +```bash +curl -X POST https://api.mintlify.com/api/feedback \ + -H "Content-Type: application/json" \ + -d '{ + "domain": "your-docs-domain.mintlify.app", + "path": "/getting-started", + "helpful": true, + "feedback": "Clear setup instructions with good code examples." + }' +``` + + + The domain of your documentation site (e.g., `your-docs-domain.mintlify.app` or your custom domain). + + + + The path of the documentation page the feedback is about. + + + + Whether the AI agent found the page helpful. + + + + Optional written feedback with additional context about the page. + + +This endpoint is unauthenticated and rate-limited to 10 requests per hour per IP address. + ## Use feedback data Review your feedback data to: