List Documentation Gaps
Open documentation gaps detected from AI assistant questions, most asked first.
Returns the project's open documentation gaps — topics visitors asked the AI assistant about that the docs could not answer well, or that readers reported from agent mode — most asked first, with where each was seen and a link to dismiss it.
Session JWT and org membership required. Any role can read it — an API key gets 401, a non-member 403. Any plan.
Path Parameters
projectIdQuery Parameters
limit20offset0.0sourcereported lists only gaps readers reported with Report a docs gap; inferred only gaps inferred from low-confidence answers. Omit it for both. total counts the filtered list. Any other value is a 400.Response Fields
totalsource, across every page — all open gaps when source is omitted. Top level, next to data.data[].topicdata[].sampleQuestionsdata[].frequencycreatedAt.data[].avgConfidencedata[].sourcereported when at least one reader reported this topic from agent mode, otherwise inferred (seen only in low-confidence answers). A reader's report turns an inferred gap into a reported one; it never turns back. In the dashboard, reported gaps carry a Reported badge, and Insights › Content health can show only those with Reported by readers.data[].periodfrequency counts over, "since YYYY-MM-DD" (the gap's createdAt).data[].sources["Assistant"], plus "Search" when a search from the last 30 days that found nothing is part of the topic — for example the search "rotate api key" inside the question above — plus "Readers" when source is reported. Searches under 4 characters are ignored.data[].signaldata[].dismissUrlhttps://api.syntext.dev.Rows do not include resolved: every row this endpoint returns is open.
total, period, sources, signal and dismissUrl are optional. If they cannot be computed, the response falls back to { "data": [...] } with the stored gap rows as they are — those rows do include projectId, resolved, dismissedBy and dismissedAt, and there is no total.
Dismissed gaps come back
Dismissing a gap removes it from this list. If visitors ask the same question again, the gap reopens with fresh counts: frequency starts at 1 and createdAt (and so period) is the moment it reopened. A reader's report never reopens a dismissed gap — only a new low-confidence answer does.
Error Responses
400 Bad Request
source is not reported or inferred (INVALID_REQUEST).
401 Unauthorized
Missing, invalid or expired session JWT, or an API key.
403 Forbidden
You are not a member of the organization that owns the project.
404 Not Found
The project does not exist or has been deleted.