Skip to content

CreateStatusRequest

A new status.

object
text
required

The plain text; the server links mentions, hashtags, and URLs.

string
>= 1 characters
spoiler_text

The content warning; omitted or empty for none. It counts toward max_post_characters.

string
sensitive

Whether the media are sensitive.

boolean
language

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

string
>= 1 characters <= 35 characters
visibility
required

Who may see a status: public everyone, listed on public timelines; local logged-in users of this instance and followers; unlisted everyone, kept off public timelines; private followers and mentioned accounts; direct mentioned accounts.

string
Allowed values: public local unlisted private direct
in_reply_to_id

The ID of a resource, a UUIDv7 in its canonical string form.

string format: uuid
media

The media to attach, in order.

Array<object>
<= 4 items

A media file to attach, with its alternative text.

object
id
required

The ID of a resource, a UUIDv7 in its canonical string form.

string format: uuid
description

The alternative text; omitted or empty for none. While the instance requires alt text (limits.require_media_description of GET /instance), a post or an edit whose media file has none, or only spaces, is a 422.

string
<= 1500 characters
poll

Schema: PollInput

object
quoted_status_id

The status to quote. It must be one the user may see and may quote (quote of Status.permissions is not denied); a quote of a boost is a quote of the boosted status. A local, private, or direct status may not quote a remote status: that is a 422, and nothing is created. Quoting a remote status while the instance does not send posts out (Instance.federation.mode off or inbound) is the 403 /api/v1/problems/federation-restricted.

string format: uuid
interaction_policy

Who may reply to, boost, and quote the new status; the kinds left out take the user’s default_interaction_policy.

Schema: InteractionPolicyChange

object

Example generated

{
"text": "example",
"spoiler_text": "example",
"sensitive": true,
"language": "example",
"visibility": "public",
"in_reply_to_id": "01890a5d-ac96-774b-bcce-b302099a8057",
"media": [
{
"id": "01890a5d-ac96-774b-bcce-b302099a8057",
"description": "example"
}
],
"poll": {},
"quoted_status_id": "01890a5d-ac96-774b-bcce-b302099a8057",
"interaction_policy": {}
}

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

Analytics on this site