Get the site brief
The site brief says what the site is for: head holds the purpose, audience, priorities, editing model, design direction and the site's rules & guidelines (head.rules), and notes holds the free-form notes. sectionNotes holds the Design system, Content & CMS and SEO notes that are set. aiAccess is what AI agents may do on the site, and ruleFailures the failing Rules per section from the last check, which ran at ruleFailuresCheckedAt (all three also on the 404 and 409 answers). Add ?page=<content key> to read one page's brief instead.
A site that has no brief yet answers 404 brief_not_set. hash changes on every write.
Request
- Base URL: https://api.dotsy.ai
- URL: https://api.dotsy.ai/api/v1/sites/{slug}/brief
- Auth: one of:
- HTTP bearer
- HTTP bearer
Path parameters
Site slug or site id (UUID). An old slug answers 301/308 and a site id 307 to the canonical slug path.
Query parameters
A page's content key (for example pricing.html). Reads or writes that page's brief instead of the site brief. Must be a normal content key: not empty, not reserved, no .., no leading or trailing /.
Response
The site brief, or the page brief when ?page= was sent.
Changes
No recorded changes to this operation across all 1 revision of this API.