Docs feedback

Base URL: $PUBLIC_API

The object

idstring · required

Feedback identifier

pathstring · required

Documentation page path

helpfulboolean · required

The recorded vote

created_atstring (date-time) · required

When the vote was recorded

The object
{
  "id": "pub_2eq3dMuVtYiTfmIR9oS1XKax9Ys",
  "path": "path",
  "helpful": true,
  "created_at": "2026-11-19T09:30:00Z"
}

Rate a documentation page as helpful or not

Logs

POST /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

pathstring · required

Documentation page path; starts with / and contains no "..", "?" or "#"

helpfulboolean · required

True when the page was helpful

commentstring · optional

Optional comment

localestring · optional · default pt

Language of the page

one of pt, en

challenge_tokenstring · optional

Bot-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

201 Feedback recorded

Show attributes
idstring · required

Feedback identifier

pathstring · required

Documentation page path

helpfulboolean · required

The recorded vote

created_atstring (date-time) · required

When the vote was recorded

Errors 400 · 403 · 413 · 429

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"
}'
Response 201
{
  "id": "pub_2eq3dMuVtYiTfmIR9oS1XKax9Ys",
  "path": "path",
  "helpful": true,
  "created_at": "2026-11-19T09:30:00Z"
}