Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 42 additions & 2 deletions optimize/feedback.mdx
Original file line number Diff line number Diff line change
@@ -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"]
---

<Info>
Expand Down Expand Up @@ -53,6 +53,7 @@
- **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

Expand Down Expand Up @@ -80,7 +81,7 @@

- **Pending**: Feedback is awaiting review.
- **In Progress**: Work is in progress to address the feedback.
- **Resolved**: Feedback has been resolved.

Check warning on line 84 in optimize/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/feedback.mdx#L84

In general, use active voice instead of passive voice ('been resolved').
- **Dismissed**: Feedback is irrelevant or inaccurate.

### Filter by status
Expand All @@ -101,6 +102,45 @@

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.

Check warning on line 107 in optimize/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/feedback.mdx#L107

In general, use active voice instead of passive voice ('is collected').

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."
}'
```

<ParamField body="domain" type="string" required>
The domain of your documentation site (e.g., `your-docs-domain.mintlify.app` or your custom domain).

Check warning on line 127 in optimize/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/feedback.mdx#L127

Use 'for example' instead of 'e.g.'.
</ParamField>

<ParamField body="path" type="string" required>
The path of the documentation page the feedback is about.
</ParamField>

<ParamField body="helpful" type="boolean" required>
Whether the AI agent found the page helpful.
</ParamField>

<ParamField body="feedback" type="string">
Optional written feedback with additional context about the page.
</ParamField>

This endpoint is unauthenticated and rate-limited to 10 requests per hour per IP address.

## Use feedback data

Review your feedback data to:
Expand Down
Loading