Rate a documentation page as helpful or not
LogsPOST /docs-feedback
Records an anonymous helpful or unhelpful vote on a documentation page, with an optional comment. path must start with /, be at most 256 characters and contain no "..", "?" or "#"; helpful is required; comment is at most 500 characters; locale is pt (default) or en. The body is at most 4096 bytes (413 PAYLOAD_TOO_LARGE). When the installation uses its built-in bot challenge, an anonymous UI request must carry challenge_token (scope intake.docs_feedback): a missing token returns 403 CHALLENGE_REQUIRED and a rejected one 403 CHALLENGE_FAILED; a signed-in caller, or an installation using an external challenge provider, is not asked for a token. At most 20 votes per IP address are accepted per hour; beyond that the response is 429 RATE_LIMITED with Retry-After.
Body application/json
pathDocumentation page path; starts with / and contains no "..", "?" or "#"
helpfulTrue when the page was helpful
commentOptional comment
localeLanguage of the page
one of
pt,enchallenge_tokenBot-challenge token when the built-in challenge is enabled (anonymous callers). Only UI requests (browser headers, the dashboard, or X-Client mobile or desktop) are challenged; API requests never are.
Returns
curl -X POST "$PUBLIC_API/docs-feedback" \
-H "Content-Type: application/json" \
-d '{
"path": "/docs/api/authentication",
"helpful": true,
"comment": "comment",
"locale": "pt",
"challenge_token": "challenge token"
}'
# No matching CLI command; use cURL or direct HTTP.
const res = await fetch("$PUBLIC_API/docs-feedback", {
method: "POST",
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({
"path": "/docs/api/authentication",
"helpful": true,
"comment": "comment",
"locale": "pt",
"challenge_token": "challenge token"
})
});
const data = await res.json();
import requests
res = requests.post(
"$PUBLIC_API/docs-feedback",
json={
"path": "/docs/api/authentication",
"helpful": true,
"comment": "comment",
"locale": "pt",
"challenge_token": "challenge token"
}
)
data = res.json()
body := strings.NewReader(`{
"path": "/docs/api/authentication",
"helpful": true,
"comment": "comment",
"locale": "pt",
"challenge_token": "challenge token"
}`)
req, _ := http.NewRequest("POST", "$PUBLIC_API/docs-feedback", body)
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
{
"id": "pub_2eq3dMuVtYiTfmIR9oS1XKax9Ys",
"path": "path",
"helpful": true,
"created_at": "2026-11-19T09:30:00Z"
}