Skip to content

EditArticleRequest

The new content of an article.

object
title
required

The title of an article, as plain text; surrounding spaces are dropped, and a blank title is a 422.

string
>= 1 characters <= 200 characters
summary

The summary of an article, as plain text. Omitted or blank, the server makes one from the start of the body (about 200 characters, cut at the end of a sentence or word). It is a summary, never a content warning.

string
<= 500 characters
cover
object
text
required

The body of an article in Markdown, as createArticle describes it. Its HTML may be at most Instance.limits.articles.max_bytes bytes.

string
>= 1 characters
tags

The hashtags of an article, with or without #; the hashtag timelines and search show the article under them. A name that is no hashtag is a 422. The #name in the body are text.

Array<string>
<= 10 items
language

A BCP 47 language tag; omitted means the user’s default post language.

string
>= 1 characters <= 35 characters
sensitive

Whether the body and the cover are folded behind the title and the summary.

boolean

Example generated

{
"title": "example",
"summary": "example",
"cover": {},
"text": "example",
"tags": [
"example"
],
"language": "example",
"sensitive": true
}

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

Analytics on this site