◆ Sapport for developers API reference Error catalog OpenAPI
Sections

#Article Publisher: Overview

Status: publishing to a site through a module is Available; reading articles through the API (GET /articles, GET /articles/{id}) is Available; editing, approval, publishing, and generation through the API are Planned. Through the Sapport dashboard, articles are created, approved, and sent to your site by the Bitrix or WordPress module today. The public API for editing and publishing (PATCH, approve, publish), generation (/articles/generation-jobs), and delivery of an article to your system are a design. The FastAPI and Nuxt packages have not been released publicly. No dates are promised.

The article publisher is a pipeline from a topic to a page on your site. The platform selects or accepts a topic, writes an article according to your editorial profile, puts it in the approval queue, and, once you have allowed it, publishes it to your site. If your site is neither Bitrix nor WordPress, the article can be handed off to your system by an event and the API, and you publish it yourself.

#What the pipeline consists of

StageWhat happensWhere it stands now
Editorial profileYou describe the niche, audience, tone, and topic sourcesDashboard: Available
GenerationAI writes the article from the topic and profile; a paid operationDashboard: Available; API: Planned
QueueThe article appears in the queue with a status, is edited and approvedDashboard: Available; reading through the API: Available, editing and approval: Planned
PublishingThe article goes to the site through a module or is handed off to youModules: Available; handoff: Planned

#Editorial profile

The profile is a precondition for generation: without it, the platform does not know what to write about or for whom. The profile includes:

FieldRequiredDescription
nicheyesThe niche: what your site is about
audiencenoWho you write for
tonenoThe tone of the text
presentationnoHow the material is presented
topic_sourcesnoWhere to take topics from: own_site, wordstat, search_console, competitors, manual, urls
source_urlsnoAddresses to draw on
avoidnoWhat to avoid
example_textnoA sample text to model on
localenoThe language of the articles

If the profile is not filled in, a generation request is refused with 409 editorial_profile_required (a code from the error catalog).

#What an article is on the platform

An article has a lifecycle status:

StatusMeaning
draftDraft: just generated or being edited
reviewUnder review
approvedApproved, ready to publish
publishedPublished
transferredMoved to another place on the platform
externalPublished outside the platform (an external article)

The internal statuses are shown for understanding. The set and names of statuses in the public API have not been approved in the design (see "Open questions"). The public status "Published" must be confirmed by a real page address, not by a single flag.

#Two ways to get an article onto a site

#Way 1. To the site through a module

This fits if you have Bitrix (module 1.2.1) or WordPress (module 1.1.1). You bind the site with the module, then click "Publish to site via module" in the dashboard. The platform builds a job; the module picks it up on its next poll (every 10 minutes; the hourly heartbeat also tells the module about pending jobs), applies it, and returns the outcome: the page address or the reason for refusal.

For details, the job format, and result codes, see Publishing through modules.

#Way 2. Handing the article off to your system

This fits if you have your own CMS. The platform announces the article.ready event, you fetch the text through the API (GET /articles/{id}, formats html, markdown, blocks), publish it on your side, and report the page address. Until the address is confirmed, the article is considered handed off, not published.

This scheme is Planned; its steps are described in the articles API. In both ways, an article that you edit on your own site is not silently overwritten; see "Versions and conflicts" in Publishing through modules.

#Who can do what

ActionMinimum permission (dashboard)Scope (future API)
View the queue and articlesseo.viewarticles:read
Edit, approve, publishseo.managearticles:write
Order generation (paid)seo.managearticles:generate

#What is not part of the public API

Some capabilities work only on the Sapport site itself and are not available to tenants: the platform's own blog, the platform's course pages, the "deep" generation mode. The public API works with your articles and your site.

#Money

Generation is charged to the tenant's wallet. When funds are insufficient, the platform returns 402 insufficient_funds; the spending limit is set per tenant and per integration. By default, no more than 5 paid operations run at once per tenant, and the cost of one operation does not exceed the equivalent of 100 RUB in the wallet's currency (both limits are configurable; when exceeded, 402 spend_limit_reached). The cost of each operation arrives in the usage field. Publishing and editing are free. See Paid operations for details.

#Where next

#Open questions