Concepts

Sites, briefs, Beats and columns

Four nouns carry most of the product. Which of them an API key or an agent can touch is listed here.

On this page

Four nouns#

Noun	What it is	A key or an agent can
Site	A domain Brenzuri has read once. It learns the site’s voice, what it covers, and a plan of columns. Library and Beats are tabs of a site, not workspace pages.	List and read sites, read one again, read its columns and house style. Not create, pause, delete or change a site.
Brief	The request for one article: topic, angle, length, language, tone, sources to use or avoid. Creating one is free.	Create, read, change and estimate. Briefs are not deleted.
Column	A topic the site plan offers, with the independent origins found for it. A column needs 3 origins to be written without a flag.	Check a topic, read a column, write it, add sources to it.
Beat	Unattended writing on a schedule within a weekly credit budget. It writes, and delivers drafts through the site’s connection.	Nothing. Beats and their candidates are managed by people; their articles appear with `origin: beat`.

A site is read once#

“Read the site” collects pages from the site’s own domain, drafts a voice, finds the topics the site could cover and proposes a schedule. Reading again with POST /sites/{siteID}/analyze starts a job and is limited to 5 reads per workspace per day, shared with people using the interface.

A key bound to a site sees only that site. A key without a site, which only an Owner can create, sees the whole workspace.

From brief to article#

A brief is created and estimated. Nothing is spent.
POST /articles with the brief id holds the credits and returns an article in generating and a job.
The job runs find, group, read, check, write, then seo if the brief asks for it, qa, and illustrate if the brief asks for an illustration. For each language version the brief names it then runs write-, seo- and qa- and the language code, as articles of their own.
The article arrives in needsReview. A person approves, and the site’s connection, if it has one, delivers the approved version as a draft.

Writing a column starts from the site plan instead of a brief: POST /sites/{siteID}/topics/{topicId}/write builds the brief itself. If that column is already being written, the running job is returned instead of starting a second.

Duplicates#

A key or an agent that asks for an article on a subject the site already has an article about is refused with 409 article_exists, naming up to three. Send alsoNew: true to write it anyway, or supersedes with the id of the article the new one replaces.