Post an article
const url = 'https://example.com/api/v1/articles';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"title":"example","summary":"example","cover":{},"text":"example","tags":["example"],"language":"example","visibility":"public","sensitive":true,"interaction_policy":{}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/articles \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "title": "example", "summary": "example", "cover": {}, "text": "example", "tags": [ "example" ], "language": "example", "visibility": "public", "sensitive": true, "interaction_policy": {} }'Posts an article as the authenticated user (201): a long post with a title, a summary, and
a cover, whose body is Markdown. The server renders the body once, now, and the article is
a Status with article from then on: its visibility, edits, interactions, reports, and
deletion (deleteStatus) are those of a post. The answer carries the body in content, as
getStatus does.
The body is CommonMark with the tables, strikethrough, and autolinks of GitHub Flavored
Markdown; raw HTML is not rendered, a line break in a paragraph is kept, and # is the
second level of heading (the title is the first). An image whose destination is
media: followed by the ID of one of the user’s own uploads that finished processing
() shows that image; any other image is a link with its alt text,
so that readers never load an image from elsewhere. Mentions link to the accounts but notify
nobody, and #name in the body stays text: the hashtags are those of tags.
A body whose HTML is over Instance.limits.articles.max_bytes bytes, or with more images
than Instance.limits.articles.max_images, is a 422; previewArticle tells both before
posting. An article is never direct (422). While the instance lets only some users write
articles (Instance.article_authoring is permission), a user without the permission
create_articles gets a 403; that user may still edit their earlier articles. Retrying
with the same Idempotency-Key returns the article posted with it, as createStatus
does. A user whose account moved gets a 403 /api/v1/problems/account-moved. When the
server’s automated review refuses the article, nothing is posted and the answer is a 422
/api/v1/problems/status-rejected, as for a post.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Header Parameters
Section titled “Header Parameters”A key the client chooses per request, which makes the request safe to send again. Within
24 hours, a request with a key that the same sign-in of the user in the same client (an
anonymous client: the same address) already sent to the operation gets the first answer
again instead of being carried out again. The same key with another request (another
path, query, or body) is a 422 /api/v1/problems/idempotency-key-reused, and a repeat
while the first request is still being carried out is a 409
/api/v1/problems/idempotency-key-in-use with a Retry-After of a second. Only an answer below 400 is kept: after a 4xx
or 5xx the key is free, so a request sent again with it is carried out. A key longer than
256 characters, or one that is not UTF-8 without U+0000, is a 422.
Request Bodyrequired
Section titled “Request Bodyrequired”A new article.
object
The title of an article, as plain text; surrounding spaces are dropped, and a blank title is a 422.
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.
Schema: ArticleCoverInput
object
The body of an article in Markdown, as createArticle describes it. Its HTML may be at most
Instance.limits.articles.max_bytes bytes.
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.
A BCP 47 language tag; omitted means the user’s default post language.
The visibility; an article is never direct (422).
Whether the body and the cover are folded behind the title and the summary.
Who may reply to, boost, and quote the new article; the kinds left out take the user’s
default_interaction_policy.
Schema: InteractionPolicyChange
object
Responses
Section titled “Responses”The posted article.
A status (post), as the viewer sees it. favourited, boosted, bookmarked, and
muted describe the authenticated user’s relation to it and are omitted for anonymous
requests; pinned is only given to the author.
In a timeline, a boost is a status of the booster with boost set to the boosted
status: its id and uri are those of the boost, created_at is when it was boosted,
visibility and language are those of the boosted status, its content,
spoiler_text, media_attachments, mentions, tags, emojis, and reactions are
empty, its card and quote are omitted, and its counts are zero.
An article (article is given) is read as its title, summary, and cover everywhere, and
its content is empty except where one article is asked for: getStatus, createArticle,
and editArticle. Timelines, notifications, streaming, search, threads, and every other list
carry no body. An article has no content warning, media attachments, or poll.
object
The ID of a resource, a UUIDv7 in its canonical string form.
The ActivityPub ID of the status.
The HTML page of the status, on the server it belongs to for a remote status; omitted when it has none.
Schema: Account
object
The text as sanitized HTML, with mentions, hashtags, and URLs linked. The HTML of a remote status is what the server’s sanitizer kept of the received document. For an article, its rendered body, or empty in lists (see above); the images in the body of an article from another server load through the server’s media proxy.
Schema: StatusArticle
object
The content warning; empty when there is none.
Whether the media are sensitive.
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.
The BCP 47 language tag of the text; und when it is unknown.
The ID of a resource, a UUIDv7 in its canonical string form.
The ID of a resource, a UUIDv7 in its canonical string form.
When the status was posted.
Schema: Status
object
When the status was last edited; omitted when it never was.
The attached media, in order.
A media file, as an upload of the user (the media operations) or as an attachment of
a status (Status.media_attachments). url, preview_url, variants, and blurhash
are present once the file is ready; statuses attach only ready files. In a status,
description is the status revision’s own copy of the alternative text, absent when the
attachment has none.
A file of a remote status is always ready: the instance does not process it, so it has
no variants; url and preview_url are its media proxy URLs,
remote_url its URL on the remote server, and meta, blurhash, and type what the
remote server declared.
object
The ID of a resource, a UUIDv7 in its canonical string form.
The kind of media. An accepted upload is an image, a video, or an audio file;
a file that failed processing is unknown. gifv is a remote video that plays like
an animated image: muted, looped, without controls.
The processing state: processing until the server has re-encoded the file,
then ready, or failed when the content could not be processed.
The alternative text; absent when there is none.
The blurhash (https://blurha.sh) of the image, to show while it loads.
Schema: MediaMeta
object
Schema: MediaVariants
object
Where the file is served on this instance; for an upload, variants.large.url, or
variants.animated.large.url for an animation, and the file itself for a video or
audio file.
Where its preview is served; for an upload, variants.small.url (still). A video or
audio file without a poster has none.
The file’s URL on the remote server, for a file of a remote status; clients load url instead.
The number of media attachments of a remote status that the server left out: it keeps
the first four attachments of a remote post. Clients show that there are more and link
to url (or uri). Omitted when none were left out.
The accounts the text mentions.
An account that a status mentions.
object
The ID of a resource, a UUIDv7 in its canonical string form.
The username, without the domain.
The username for local accounts, username@domain for remote ones.
The account’s profile page.
The hashtags of the text.
A hashtag of a status.
object
The hashtag as written, without #.
The hashtag’s page.
The user’s keyword filters with the action warn that the post matched where it is shown,
with the words each matched; empty when none did, and always for an anonymous request.
Clients fold a post with any behind the titles of its filters, with a way to show it. A
post that matches a filter with the action hide is left out instead, except the post
that GET /api/v1/statuses/{id} shows, which is folded. In a
timeline, a boost carries the filters that the boosted post matched. A quoted post carries
its own: a quote that matches folds only the quote, even for hide. The user’s own posts
and boosts, and what they quote, never match.
A keyword filter of the user with the action warn that a post matched, and the words it matched.
object
Schema: MatchedKeywordFilter
object
The words of the filter that the post matched, as the user typed them.
On the home timeline and its stream, the names (without #) of the hashtags that the
user follows and the post carries, when the post is there only for them: its author is
neither the user nor an account the user follows. Omitted everywhere else.
The custom emoji of the text, the content warning, and the poll’s choices. Clients show each :shortcode: of those texts that is in this list as its
image, and the rest as text. Empty for a boost, whose emoji are those of boost.
A custom emoji that a text uses. The text has it as :shortcode:.
An emoji that is disabled or deleted, or whose images come from a domain whose media the
instance rejects, is not listed, and its :shortcode: stays text. Clients show
static_url when animations should not play (prefers-reduced-motion), and url
otherwise.
object
The shortcode, without the colons around it.
The URL of the image, animated when the emoji is.
The URL of a still image of the emoji; the same as url when no still version is served.
The number of replies.
The number of boosts.
The number of favourites.
The emoji reactions to the status, counted per emoji: the 20 emoji with the most
reactions, the most first. The others are seen in listStatusReactions. Favourites
are counted apart, in favourites_count.
The reactions to a status with one emoji.
object
The emoji as listStatusReactions takes it: the Unicode emoji, the shortcode of a
custom emoji of this server, or shortcode@domain for a custom emoji of another
server.
The shortcode of a custom emoji, without colons; omitted for a Unicode emoji.
The server of a custom emoji of another server; omitted otherwise.
The custom emoji with its image; omitted for a Unicode emoji and when the image cannot
be shown (as CustomEmoji leaves such an emoji out).
Schema: CustomEmoji
object
The number of the reactions with the emoji.
Whether the authenticated user reacted with the emoji; omitted for anonymous requests.
Whether the authenticated user favourited the status.
Whether the authenticated user boosts the status.
Whether the authenticated user bookmarked the status.
Whether the authenticated user mutes the thread (conversation) of the status, which
keeps the user from being notified of what happens in it (muteStatusThread).
Whether the status is pinned to the author’s profile; given only to the author.
The approval of this reply by the author of the status it replies to, while it is not
given; given only to the author of the reply, and omitted for a reply that needs no
approval or has it. A pending reply is shown to its author alone.
The approval of the authenticated user’s boost of the status by its author, while it is
not given; omitted when the user did not ask for one or it is given (then boosted is
true).
Schema: Poll
object
Schema: LinkCard
object
The status that this status quotes; omitted when it quotes none, and in a
quoted_status.
Schema: StatusQuote
object
The board of an event that the status is posted on; omitted for any other status.
Schema: StatusEventBoard
object
What the authenticated user may do with the status: reply to it, boost it, and quote it.
Omitted for anonymous requests. A post of the board of an event (event_board) is never
boosted or quoted, and is replied to (on its board) only by the users who may post there.
Schema: InteractionPermissions
object
Who may reply to, boost, and quote the status; given only to its author.
Schema: InteractionPolicy
object
Example
{ "id": "01890a5d-ac96-774b-bcce-b302099a8057", "visibility": "public", "in_reply_to_id": "01890a5d-ac96-774b-bcce-b302099a8057", "in_reply_to_account_id": "01890a5d-ac96-774b-bcce-b302099a8057", "media_attachments": [ { "id": "01890a5d-ac96-774b-bcce-b302099a8057", "type": "image", "state": "processing" } ], "mentions": [ { "id": "01890a5d-ac96-774b-bcce-b302099a8057" } ], "approval": "pending", "boost_approval": "pending"}Headers
Section titled “Headers”The caching policy. Anonymous public GETs are cacheable by shared caches.
The post was refused; nothing was posted.
The problem of a post that the server’s automated review refused (422,
/api/v1/problems/status-rejected). Nothing was posted. title and detail are fixed text
that holds nothing of the review’s answer. The author may appeal the decision with
POST /hook_decisions/{hook_decision_id}/appeal until appeal_deadline, sending the text
of the post. Another 422 (a malformed request) has neither member.
object
A URI that identifies the problem type, stable for clients to branch on.
It is about:blank when the problem means no more than its HTTP status.
A short summary of the problem type, localized from Accept-Language.
The HTTP status code.
An explanation of this occurrence, localized from Accept-Language.
The request ID (the X-Request-Id response header), for reporting the problem.
The member of the request that a 422 is about, by its name in the request: a property of
the JSON body by its path (display_name, fields[].name, poll.options[1]), a form
field, a query parameter, or a header (Idempotency-Key). detail then says what is
wrong with its value without naming it, for the client to show beside that field. Absent
when the problem is not about one member.
The decision to appeal.
The last moment the author can appeal the decision.
Example
{ "hook_decision_id": "01890a5d-ac96-774b-bcce-b302099a8057"}Headers
Section titled “Headers”The locale of title and detail.
The caching policy. Anonymous public GETs are cacheable by shared caches.
default
Section titled “default”An error, as an RFC 9457 problem document.
An RFC 9457 problem document. Besides about:blank, type is one of
/api/v1/problems/unauthenticated(401): the operation needs an access token and the request has none./api/v1/problems/invalid-token(401): the access token is malformed, unknown, expired, or revoked. Refresh it or sign in again./api/v1/problems/insufficient-scope(403): the access token lacks the scope thatWWW-Authenticatenames./api/v1/problems/first-party-only(403): the operation (password, two-factor authentication, passkeys, deleting the account) takes only the token of one of the server’s own clients, whatever its scopes./api/v1/problems/account-unavailable(403): the token is valid, but its user cannot use the app (registration pending or rejected, email unverified, the account deactivated or deleted, or a moderation action that disables its login). The user can still sign in to the server’s sign-in page, which says why./api/v1/problems/idempotency-key-reused(422): theIdempotency-Keywas sent to the operation with another request in the last 24 hours. Choose a new key for a new request./api/v1/problems/idempotency-key-in-use(409): the request with thisIdempotency-Keyis still being carried out. Send it again afterRetry-Afterfor its answer./api/v1/problems/blocking(409): the viewer blocks the account, which keeps them from following it. Unblock it first./api/v1/problems/federation-restricted(403): the instance’s federation mode (Instance.federation.mode) does not let the operation through: following a remote account or resolving one (off,outbound), or quoting a remote status (off,inbound)./api/v1/problems/media-too-large(413): the uploaded file is larger than the instance accepts./api/v1/problems/unsupported-media-format(415): the uploaded file is not in an accepted format or codec (such as HEVC video), or its declared type does not match its content./api/v1/problems/media-dimensions(422): the image is too wide or tall, or has too many pixels or frames; or the video has too many pixels or frames per second./api/v1/problems/media-too-long(422): the video or audio file is longer than the instance accepts./api/v1/problems/media-corrupt(422): the uploaded file cannot be read as a file of its format./api/v1/problems/media-attached(409): the media file is attached to a post and can no longer be changed on its own./api/v1/problems/too-many-streams(429): the user already has as many streams (GET /streaming) open as the server allows. Close one first./api/v1/problems/missing-permission(403): the user’s roles lack the permission that an admin operation needs./api/v1/problems/already-appealed(422): the user already appealed the moderation action or the refusal of a post; each is appealed once./api/v1/problems/appeal-window-closed(422): the time to appeal the moderation action or the refusal of a post has passed./api/v1/problems/not-appealable(422): the moderation action is a ban whose account is deleted, so it can no longer be appealed or overturned; or the decision of the automated review is not a refusal of the user’s post that is in force./api/v1/problems/appeal-decided(409): the appeal was already decided the other way./api/v1/problems/wrong-password(422): the password given to confirm the operation is not the user’s current password./api/v1/problems/deactivation-refused(409): the user’s own account cannot be deactivated now; the detail says why./api/v1/problems/export-in-progress(409): another data export of the user is being built. Wait for it to end./api/v1/problems/export-not-ready(409): the data export has no archive to download: it is being built, failed, or expired./api/v1/problems/import-in-progress(409): another import of the user is being carried out. Wait for it to finish./api/v1/problems/invalid-two-factor-code(422): the two-factor code is wrong, was already used, or is not a code./api/v1/problems/totp-setup-expired(422): the TOTP setup is unknown or expired. Start a new one./api/v1/problems/two-factor-enabled(409): the user already has two-factor authentication./api/v1/problems/two-factor-not-enabled(409): the user, or the account of an admin operation, has no two-factor authentication./api/v1/problems/invalid-passkey(422): the browser’s response to a passkey registration or confirmation does not verify, the passkey is registered already, or the passkey that confirms an operation is not one of the user’s./api/v1/problems/passkey-registration-expired(422): the passkey registration is unknown or expired. Start a new one./api/v1/problems/passkey-confirmation-expired(422): the confirmation with a passkey is unknown, expired, or used. Start a new one./api/v1/problems/too-many-passkeys(409): the user already has the most passkeys allowed. Remove one first./api/v1/problems/last-sign-in-method(409): the operation would leave the user no way to sign in: the password, the last passkey, or the last linked account when nothing else signs the user in./api/v1/problems/login-providers-only(403): registration and sign-in are limited to the login providers, so a password cannot be set and a passkey cannot be added./api/v1/problems/external-confirmation-expired(422): the confirmation with a linked login provider is unknown, expired, used, or for another operation. Start a new one./api/v1/problems/login-provider-unavailable(422): the login provider is unknown or disabled, does not allow links, or the user links no account at it./api/v1/problems/login-provider-linked(409): the user links an account at the login provider already./api/v1/problems/too-many-oauth-apps(409): the user already has the most OAuth apps allowed (25). Delete one first./api/v1/problems/oauth-app-registration-disabled(403): the server does not let users register OAuth apps./api/v1/problems/public-oauth-app(409): the OAuth app is public and has no secret./api/v1/problems/oauth-app-disabled(409): an administrator disabled the OAuth app./api/v1/problems/invalid-custom-emoji(422): a custom emoji breaks a rule;reasonsays which./api/v1/problems/invalid-webhook(422): a webhook breaks a rule;reasonsays which./api/v1/problems/invalid-relay(422): a relay cannot be registered, joined, left, or deleted;reasonsays why./api/v1/problems/invalid-theme(422): the theme’s token set breaks a rule; the problem lists every reason intheme_errors(PUT /admin/theme/draft,POST /admin/theme/publish,POST /admin/theme/restore)./api/v1/problems/invalid-brand(422): the brand image breaks a rule;brand_errorsays why (/admin/instance/brand/...)./api/v1/problems/service-closure-state(409): the state of the service closure does not allow the operation: withdrawing an announcement when none is in effect, announcing the closure of a server that is closed already (/admin/closure/announcement), or closing a server whose closure is not announced or whosecloses_athas not come (POST /admin/closure/close)./api/v1/problems/service-closing(409): the closure of the service is announced, which stops new registrations and supporter subscriptions: approving a pending registration (/admin/registrations/{id}/approve) or starting a supporter checkout (POST /supporter/checkout)./api/v1/problems/service-closed(403): the server is closed. A closed server serves only the operations with which the users take their data away: their own account and preferences (verify_credentials,/preferences,/accounts/password,/two_factor,/passkeysread), the exports (/exports,/csv_exports), their sessions (/sessions,/authorized_apps),GET /instance,GET /instance/health,GET /instance/documents,POST /client_errors, and the administrators’ operations that follow the closure (/admin/closure,/admin/queue,/admin/jobs). Every other operation, the streaming endpoint included, is refused with this problem; signing in and resetting a password stay available outside the client API./api/v1/problems/too-many-domain-mutes(422): the user already mutes the most domains allowed. Unmute one first./api/v1/problems/too-many-keyword-filters(422): the user already has the most keyword filters allowed. Delete one first./api/v1/problems/too-many-filter-keywords(422): the words would pass the most a keyword filter, or all the user’s filters together, may have. Remove some first./api/v1/problems/too-many-lists(422): the user already has the most lists allowed. Delete one first./api/v1/problems/too-many-list-members(422): the list already has the most members allowed. Remove one first./api/v1/problems/not-followed(422): only an account that the user follows (whose follow request was accepted) can be added to a list./api/v1/problems/follows-hidden(403): the account’sfollows_visibilitykeeps its follows and followers lists from the viewer (/accounts/{id}/following,/accounts/{id}/followers). Its counts stay on the account./api/v1/problems/too-many-followed-tags(422): the user already follows the most hashtags allowed (100). Unfollow one first./api/v1/problems/too-many-featured-tags(422): the user asked to feature more hashtags than allowed (10)./api/v1/problems/invalid-alias(422): the handle or URL of an alias leads to no account’s actor, or to the user itself./api/v1/problems/too-many-aliases(422): the user already has the most aliases allowed (5). Remove one first./api/v1/problems/role-managed-by-plan(409): the role is the role of a supporter plan: only its subscriptions grant and revoke it, and its permissions and position change from the plan (PATCH /admin/supporter_plans/{id}). Its badge changes as any role’s./api/v1/problems/breaks-supporter-roles(409): the change would put a staff role (one with a moderation or server permission) at or below the role of a supporter plan./api/v1/problems/supporters-unavailable(409): the supporter program needs a payment provider in the deployment’s configuration and a server that sends email./api/v1/problems/live-subscriptions(409): subscriptions to the supporter plans go on; retire the plans and wait for the subscriptions to end before disabling the program./api/v1/problems/invalid-supporter-plan(422): a supporter plan breaks a rule;reasonsays which./api/v1/problems/supporter-plan-retired(409): the supporter plan is retired and does not change any more./api/v1/problems/subscription-ended(409): the subscription has ended already./api/v1/problems/supporter-ineligible(422): the user may not subscribe to a supporter plan: not a local user, the primary email address is not verified, or the account is restricted./api/v1/problems/supporter-subscribed(409): the user has a subscription that goes on already; change its plan instead./api/v1/problems/supporter-plan-unavailable(422): the supporter plan takes no subscriptions: hidden, retired, not ready, or of another currency./api/v1/problems/supporter-subscription-state(409): the subscription’s state does not allow the operation./api/v1/problems/supporter-same-plan(422): the subscription has that plan and interval already./api/v1/problems/supporter-payment-failed(402): the payment of a change of plan failed, or the card needs an authentication that the change cannot ask for. The plan stays and nothing was charged; update the card and try again./api/v1/problems/supporter-payment-processing(409): the payment of a change of plan has not settled. The plan stays, and moves if the payment succeeds./api/v1/problems/supporter-tip-amount(422): the amount of the tip is not one of the amounts ofGET /instance/tip_amounts./api/v1/problems/supporter-tip-pending(409): another start of a tip of the user’s runs at the same time; try again./api/v1/problems/tips-unavailable(409): the tips need the supporter program enabled on the configured payment provider, which takes one-time payments./api/v1/problems/invalid-tip-amounts(422): the amounts of the tips break a rule;reasonsays which./api/v1/problems/voice-not-eligible(403): the user may not host voice chat rooms./api/v1/problems/voice-not-host(403): only the host of the voice chat room may do this./api/v1/problems/voice-room-full(409): the voice chat room holds as many people as the server allows./api/v1/problems/voice-too-many-rooms(409): as many voice chat rooms are open as the server allows./api/v1/problems/voice-hosting-elsewhere(409): the user hosts another open voice chat room; leave it first, choosing the next host or ending it./api/v1/problems/voice-host-must-choose(409): the host leaves a room with other participants; choose the next host or end the room./api/v1/problems/voice-invalid-next-host(422): the next host is not a participant of the room who may host rooms./api/v1/problems/voice-conflict(409): the room changed meanwhile; try again./api/v1/problems/voice-unavailable(503): the server could not prepare the connection to the room./api/v1/problems/invites-not-allowed(403): the user may not create invites of their own now: the instance settinginvite_creatorsand the user’s roles do not let them, the account is suspended or limited, its registration is not approved, or the registration isclosed. Itsreasonsays which./api/v1/problems/too-many-invites(409): the user already holds as many usable invites as the instance settingmember_invite_max_activeallows. Revoke one or wait for one to expire or be used up./api/v1/problems/registration-closed(409): the registration mode isclosed, which takes no invite./api/v1/problems/target-outranks-actor(403): the admin operation on an account needs the user to rank above the account: the highestpositionamong the user’s roles must be above that of every role of the account, so it refuses a higher or equal rank and the user’s own account./api/v1/problems/last-administrator(409): the operation would leave the instance without an administrator. Make another user an administrator first./api/v1/problems/account-moved(403): the user’s account moved to another account, so it cannot post, boost, react, follow, or vote. Cancel the move first (DELETE /accounts/move)./api/v1/problems/posting-restricted(403): a moderation action keeps the user’s account from posting: a post, an article, a post on an event’s board, an edit, or a boost. The user appeals it from Account status in the settings (/settings/account/statusof the web client)./api/v1/problems/interaction-restricted(403): a moderation action keeps the user’s account from interacting: following, favouriting, boosting, reacting, replying, quoting, or voting in a poll. The user appeals it as a posting restriction./api/v1/problems/current-session(409): the browser that asks cannot sign itself out throughDELETE /sessions/{id}; signing out ends it./api/v1/problems/account-not-moved(409): the user’s account has not moved, so there is no move to cancel./api/v1/problems/move-alias-missing(422): the account to move to does not list the user’s account among its aliases (alsoKnownAs). Add the alias on that account first./api/v1/problems/move-target-moved(422): the account to move to moved itself./api/v1/problems/move-target-unavailable(422): the account to move to is the user’s own, is not found, cannot be fetched from its server, or is suspended here./api/v1/problems/move-too-soon(422): the user’s account moved less than 30 days ago, also counting a canceled move;can_move_atsays from when it can move again./api/v1/problems/move-repeated(422): the user’s account moved to that account before, and it moves to an account once./api/v1/problems/maintenance(503): the server is under maintenance and answers every operation with this problem andRetry-After. Keep the tokens, show the maintenance, and retry afterRetry-After. Its members besides the standard ones, each present only when the operator set it:message, the administrators’ notice in plain text;until, when the maintenance is expected to end (RFC 3339); andstatus_page_url, the instance’s status page./api/v1/problems/custom-emoji-request-conflict(409): a request for a custom emoji is not in the state the operation needs, or was decided meanwhile./api/v1/problems/email-already-verified(409): the primary email address is already confirmed, so no confirmation mail is sent./api/v1/problems/hook-decision-not-overridable(409): the decision of a decision hook had no effect, or is arejectoflocal.status, which goes through its appeal./api/v1/problems/report-not-forwardable(409): the report cannot be forwarded to the target’s server: it came from another server, is about a local account or a voice chat room, or its target is gone./api/v1/problems/status-rejected(422): the server’s automated review refused the post and nothing was posted. The problem carrieshook_decision_idandappeal_deadline; the user may appeal (POST /hook_decisions/{id}/appeal)./api/v1/problems/profile-rejected(422): the server’s automated review refused the change of the profile, which stays as it was. It cannot be appealed; the user may change the profile and save it again./api/v1/problems/email-not-suppressed(409): the email address of the account is not suppressed, so there is nothing to lift./api/v1/problems/invalid-login-provider(422): a login provider breaks a rule;reasonsays which./api/v1/problems/invalid-role(422): a role change breaks a rule;reasonsays which./api/v1/problems/translation-failed(503): no translation provider returned a usable translation; asking again may work./api/v1/problems/translation-limit(429): a monthly limit on translated characters is reached, until the next month in UTC./api/v1/problems/translation-unavailable(422): no translation provider may receive the post./api/v1/problems/translation-unsupported-language(422): the translation providers do not translate the language./api/v1/problems/voice-already-invited(409): the account is already invited to the room./api/v1/problems/voice-cannot-speak(403): the participant may not speak in the room./api/v1/problems/voice-invalid-invitee(422): the account cannot be invited to the room./api/v1/problems/voice-invalid-participant(422): the account is not a participant that the operation can act on./api/v1/problems/voice-not-host-or-cohost(403): the operation is for the host and the co-hosts of the room./api/v1/problems/voice-too-many-cohosts(409): the room has as many co-hosts as it can./api/v1/problems/event-not-eligible(403): the user may not create events./api/v1/problems/event-not-organizer(403): the operation is for the organizer and the co-organizers of the event./api/v1/problems/event-organizer-only(403): the operation is for the organizer of the event./api/v1/problems/event-closed(409): the event was cancelled, or has started for an answer./api/v1/problems/event-full(409): the attendees who answergoingreached the capacity./api/v1/problems/event-voice-unavailable(422): the event cannot be held in a voice chat room: the voice chat is off, or its organizer may not host rooms./api/v1/problems/event-already-invited(409): the account is already invited to the event./api/v1/problems/event-invalid-invitee(422): the account cannot be invited to the event./api/v1/problems/event-invalid-coorganizer(422): the account cannot co-organize the event./api/v1/problems/event-too-many-coorganizers(409): the event has as many co-organizers as it can./api/v1/problems/event-not-attending(422): the account does not answergoingormaybe./api/v1/problems/event-attendee-organizes(422): the account organizes or co-organizes the event, so it always sees the places and is not approved or revoked./api/v1/problems/event-board-not-reader(403): the user sees the event but does not read its board: the user neither organizes it nor answersgoingormaybe./api/v1/problems/event-board-not-writer(403): the event’sboard_writersdo not let the user post on its board./api/v1/problems/event-board-closed(409): the board of the event is read-only: the event was cancelled, or 7 days have passed since its end (it is writable for the 7 days after the end)./api/v1/problems/event-unscheduled(409): the event polls its date and has none yet./api/v1/problems/event-scheduled(409): the date of the event was confirmed, so its date poll takes no more candidates, answers, or confirmations./api/v1/problems/event-last-candidate(409): the last candidate of a date poll cannot be withdrawn./api/v1/problems/search-unavailable(404): the server has no search engine, so posts cannot be searched (Instance.full_text_search.available)./api/v1/problems/search-failed(503): the search engine could not answer. Only the search of posts is affected; try again later./api/v1/problems/single-user-mode(404): the server is a one-person server (Instance.single_user), which does not offer the operation: the local and federated timelines, the suggestions of accounts, invites, the review of registrations, and the sign-up blocks. It works again when the server stops being one./api/v1/problems/single-user-requires-one-account(422): the instance settingsingle_usercan be turned on only while the server has exactly one local account;detailsays how many it has.
object
A URI that identifies the problem type, stable for clients to branch on.
It is about:blank when the problem means no more than its HTTP status.
A short summary of the problem type, localized from Accept-Language.
The HTTP status code.
An explanation of this occurrence, localized from Accept-Language.
The request ID (the X-Request-Id response header), for reporting the problem.
The member of the request that a 422 is about, by its name in the request: a property of
the JSON body by its path (display_name, fields[].name, poll.options[1]), a form
field, a query parameter, or a header (Idempotency-Key). detail then says what is
wrong with its value without naming it, for the client to show beside that field. Absent
when the problem is not about one member.
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "request_id": "example", "field": "example"}Headers
Section titled “Headers”The locale of title and detail.
Always no-store; problems are never cached.
The Bearer challenge of a 401 or a 403 insufficient_scope (RFC 6750 §3), with
error and, for insufficient_scope, the scope the operation needs.
The seconds to wait before retrying, on a 429 (for translation-limit, until the next
month in UTC) and on a 503 of the streaming endpoint.
For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt