Skip to content

ArticlePreview

The body of an article as publishing it would store it.

object
content
required

The body as sanitized HTML, the same as the published article’s content.

string
summary
required

The summary the article would get.

string
summary_from_body
required

Whether summary is made from the body, because the one sent was blank.

boolean
bytes
required

The UTF-8 bytes of content; over max_bytes, publishing is a 422.

integer
max_bytes
required

The most bytes of content (Instance.limits.articles.max_bytes).

integer
>= 1
images
required

The number of the user’s own uploads that the body shows as images; over max_images, publishing is a 422.

integer
max_images
required

The most images of the body (Instance.limits.articles.max_images).

integer

Example generated

{
"content": "example",
"summary": "example",
"summary_from_body": true,
"bytes": 1,
"max_bytes": 1,
"images": 1,
"max_images": 1
}

For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt

Analytics on this site