Merge branch 'develop' of https://git.pleroma.social/pleroma/pleroma into develop
[akkoma] / docs / development / API / differences_in_mastoapi_responses.md
1 # Differences in Mastodon API responses from vanilla Mastodon
2
3 A Pleroma instance can be identified by "<Mastodon version> (compatible; Pleroma <version>)" present in `version` field in response from `/api/v1/instance`
4
5 ## Flake IDs
6
7 Pleroma uses 128-bit ids as opposed to Mastodon's 64 bits. However, just like Mastodon's ids, they are lexically sortable strings
8
9 ## Timelines
10
11 Adding the parameter `with_muted=true` to the timeline queries will also return activities by muted (not by blocked!) users.
12
13 Adding the parameter `exclude_visibilities` to the timeline queries will exclude the statuses with the given visibilities. The parameter accepts an array of visibility types (`public`, `unlisted`, `private`, `direct`), e.g., `exclude_visibilities[]=direct&exclude_visibilities[]=private`.
14
15 Adding the parameter `reply_visibility` to the public and home timelines queries will filter replies. Possible values: without parameter (default) shows all replies, `following` - replies directed to you or users you follow, `self` - replies directed to you.
16
17 Adding the parameter `instance=lain.com` to the public timeline will show only statuses originating from `lain.com` (or any remote instance).
18
19 Home, public, hashtag & list timelines accept these parameters:
20
21 - `only_media`: show only statuses with media attached
22 - `local`: show only local statuses
23 - `remote`: show only remote statuses
24
25 ## Statuses
26
27 - `visibility`: has additional possible values `list` and `local` (for local-only statuses)
28
29 Has these additional fields under the `pleroma` object:
30
31 - `local`: true if the post was made on the local instance
32 - `conversation_id`: the ID of the AP context the status is associated with (if any)
33 - `direct_conversation_id`: the ID of the Mastodon direct message conversation the status is associated with (if any)
34 - `in_reply_to_account_acct`: the `acct` property of User entity for replied user (if any)
35 - `content`: a map consisting of alternate representations of the `content` property with the key being its mimetype. Currently, the only alternate representation supported is `text/plain`
36 - `spoiler_text`: a map consisting of alternate representations of the `spoiler_text` property with the key being its mimetype. Currently, the only alternate representation supported is `text/plain`
37 - `expires_at`: a datetime (iso8601) that states when the post will expire (be deleted automatically), or empty if the post won't expire
38 - `thread_muted`: true if the thread the post belongs to is muted
39 - `emoji_reactions`: A list with emoji / reaction maps. The format is `{name: "☕", count: 1, me: true}`. Contains no information about the reacting users, for that use the `/statuses/:id/reactions` endpoint.
40 - `parent_visible`: If the parent of this post is visible to the user or not.
41
42 ## Scheduled statuses
43
44 Has these additional fields in `params`:
45
46 - `expires_in`: the number of seconds the posted activity should expire in.
47
48 ## Media Attachments
49
50 Has these additional fields under the `pleroma` object:
51
52 - `mime_type`: mime type of the attachment.
53
54 ### Attachment cap
55
56 Some apps operate under the assumption that no more than 4 attachments can be returned or uploaded. Pleroma however does not enforce any limits on attachment count neither when returning the status object nor when posting.
57
58 ### Limitations
59
60 Pleroma does not process remote images and therefore cannot include fields such as `meta` and `blurhash`. It does not support focal points or aspect ratios. The frontend is expected to handle it.
61
62 ## Accounts
63
64 The `id` parameter can also be the `nickname` of the user. This only works in these endpoints, not the deeper nested ones for following etc.
65
66 - `/api/v1/accounts/:id`
67 - `/api/v1/accounts/:id/statuses`
68
69 `/api/v1/accounts/:id/statuses` endpoint accepts these parameters:
70
71 - `pinned`: include only pinned statuses
72 - `tagged`: with tag
73 - `only_media`: include only statuses with media attached
74 - `with_muted`: include statuses/reactions from muted accounts
75 - `exclude_reblogs`: exclude reblogs
76 - `exclude_replies`: exclude replies
77 - `exclude_visibilities`: exclude visibilities
78
79 Endpoints which accept `with_relationships` parameter:
80
81 - `/api/v1/accounts/:id`
82 - `/api/v1/accounts/:id/followers`
83 - `/api/v1/accounts/:id/following`
84 - `/api/v1/mutes`
85
86 Has these additional fields under the `pleroma` object:
87
88 - `ap_id`: nullable URL string, ActivityPub id of the user
89 - `background_image`: nullable URL string, background image of the user
90 - `tags`: Lists an array of tags for the user
91 - `relationship` (object): Includes fields as documented for Mastodon API https://docs.joinmastodon.org/entities/relationship/
92 - `is_moderator`: boolean, nullable, true if user is a moderator
93 - `is_admin`: boolean, nullable, true if user is an admin
94 - `confirmation_pending`: boolean, true if a new user account is waiting on email confirmation to be activated
95 - `hide_favorites`: boolean, true when the user has hiding favorites enabled
96 - `hide_followers`: boolean, true when the user has follower hiding enabled
97 - `hide_follows`: boolean, true when the user has follow hiding enabled
98 - `hide_followers_count`: boolean, true when the user has follower stat hiding enabled
99 - `hide_follows_count`: boolean, true when the user has follow stat hiding enabled
100 - `settings_store`: A generic map of settings for frontends. Opaque to the backend. Only returned in `/api/v1/accounts/verify_credentials` and `/api/v1/accounts/update_credentials`
101 - `chat_token`: The token needed for Pleroma shoutbox. Only returned in `/api/v1/accounts/verify_credentials`
102 - `deactivated`: boolean, true when the user is deactivated
103 - `allow_following_move`: boolean, true when the user allows automatically follow moved following accounts
104 - `unread_conversation_count`: The count of unread conversations. Only returned to the account owner.
105 - `unread_notifications_count`: The count of unread notifications. Only returned to the account owner.
106 - `notification_settings`: object, can be absent. See `/api/v1/pleroma/notification_settings` for the parameters/keys returned.
107 - `accepts_chat_messages`: boolean, but can be null if we don't have that information about a user
108 - `favicon`: nullable URL string, Favicon image of the user's instance
109
110 ### Source
111
112 Has these additional fields under the `pleroma` object:
113
114 - `show_role`: boolean, nullable, true when the user wants his role (e.g admin, moderator) to be shown
115 - `no_rich_text` - boolean, nullable, true when html tags are stripped from all statuses requested from the API
116 - `discoverable`: boolean, true when the user allows external services (search bots) etc. to index / list the account (regardless of this setting, user will still appear in regular search results)
117 - `actor_type`: string, the type of this account.
118
119 ## Conversations
120
121 Has an additional field under the `pleroma` object:
122
123 - `recipients`: The list of the recipients of this Conversation. These will be addressed when replying to this conversation.
124
125 ## GET `/api/v1/conversations`
126
127 Accepts additional parameters:
128
129 - `recipients`: Only return conversations with the given recipients (a list of user ids). Usage example: `GET /api/v1/conversations?recipients[]=1&recipients[]=2`
130
131 ## Account Search
132
133 Behavior has changed:
134
135 - `/api/v1/accounts/search`: Does not require authentication
136
137 ## Search (global)
138
139 Unlisted posts are available in search results, they are considered to be public posts that shouldn't be shown in local/federated timeline.
140
141 ## Notifications
142
143 Has these additional fields under the `pleroma` object:
144
145 - `is_seen`: true if the notification was read by the user
146
147 ### Move Notification
148
149 The `type` value is `move`. Has an additional field:
150
151 - `target`: new account
152
153 ### EmojiReact Notification
154
155 The `type` value is `pleroma:emoji_reaction`. Has these fields:
156
157 - `emoji`: The used emoji
158 - `account`: The account of the user who reacted
159 - `status`: The status that was reacted on
160
161 ### ChatMention Notification (not default)
162
163 This notification has to be requested explicitly.
164
165 The `type` value is `pleroma:chat_mention`
166
167 - `account`: The account who sent the message
168 - `chat_message`: The chat message
169
170 ### Report Notification (not default)
171
172 This notification has to be requested explicitly.
173
174 The `type` value is `pleroma:report`
175
176 - `account`: The account who reported
177 - `report`: The report
178
179 ## GET `/api/v1/notifications`
180
181 Accepts additional parameters:
182
183 - `exclude_visibilities`: will exclude the notifications for activities with the given visibilities. The parameter accepts an array of visibility types (`public`, `unlisted`, `private`, `direct`). Usage example: `GET /api/v1/notifications?exclude_visibilities[]=direct&exclude_visibilities[]=private`.
184 - `include_types`: will include the notifications for activities with the given types. The parameter accepts an array of types (`mention`, `follow`, `reblog`, `favourite`, `move`, `pleroma:emoji_reaction`, `pleroma:chat_mention`, `pleroma:report`). Usage example: `GET /api/v1/notifications?include_types[]=mention&include_types[]=reblog`.
185
186 ## DELETE `/api/v1/notifications/destroy_multiple`
187
188 An endpoint to delete multiple statuses by IDs.
189
190 Required parameters:
191
192 - `ids`: array of activity ids
193
194 Usage example: `DELETE /api/v1/notifications/destroy_multiple/?ids[]=1&ids[]=2`.
195
196 Returns on success: 200 OK `{}`
197
198 ## POST `/api/v1/statuses`
199
200 Additional parameters can be added to the JSON body/Form data:
201
202 - `preview`: boolean, if set to `true` the post won't be actually posted, but the status entity would still be rendered back. This could be useful for previewing rich text/custom emoji, for example.
203 - `content_type`: string, contain the MIME type of the status, it is transformed into HTML by the backend. You can get the list of the supported MIME types with the nodeinfo endpoint.
204 - `to`: A list of nicknames (like `lain@soykaf.club` or `lain` on the local server) that will be used to determine who is going to be addressed by this post. Using this will disable the implicit addressing by mentioned names in the `status` body, only the people in the `to` list will be addressed. The normal rules for post visibility are not affected by this and will still apply.
205 - `visibility`: string, besides standard MastoAPI values (`direct`, `private`, `unlisted`, `local` or `public`) it can be used to address a List by setting it to `list:LIST_ID`.
206 - `expires_in`: The number of seconds the posted activity should expire in. When a posted activity expires it will be deleted from the server, and a delete request for it will be federated. This needs to be longer than an hour.
207 - `in_reply_to_conversation_id`: Will reply to a given conversation, addressing only the people who are part of the recipient set of that conversation. Sets the visibility to `direct`.
208
209 ## GET `/api/v1/statuses`
210
211 An endpoint to get multiple statuses by IDs.
212
213 Required parameters:
214
215 - `ids`: array of activity ids
216
217 Usage example: `GET /api/v1/statuses/?ids[]=1&ids[]=2`.
218
219 Returns: array of Status.
220
221 The maximum number of statuses is limited to 100 per request.
222
223 ## PATCH `/api/v1/accounts/update_credentials`
224
225 Additional parameters can be added to the JSON body/Form data:
226
227 - `no_rich_text` - if true, html tags are stripped from all statuses requested from the API
228 - `hide_followers` - if true, user's followers will be hidden
229 - `hide_follows` - if true, user's follows will be hidden
230 - `hide_followers_count` - if true, user's follower count will be hidden
231 - `hide_follows_count` - if true, user's follow count will be hidden
232 - `hide_favorites` - if true, user's favorites timeline will be hidden
233 - `show_role` - if true, user's role (e.g admin, moderator) will be exposed to anyone in the API
234 - `default_scope` - the scope returned under `privacy` key in Source subentity
235 - `pleroma_settings_store` - Opaque user settings to be saved on the backend.
236 - `skip_thread_containment` - if true, skip filtering out broken threads
237 - `allow_following_move` - if true, allows automatically follow moved following accounts
238 - `also_known_as` - array of ActivityPub IDs, needed for following move
239 - `pleroma_background_image` - sets the background image of the user. Can be set to "" (an empty string) to reset.
240 - `discoverable` - if true, external services (search bots) etc. are allowed to index / list the account (regardless of this setting, user will still appear in regular search results).
241 - `actor_type` - the type of this account.
242 - `accepts_chat_messages` - if false, this account will reject all chat messages.
243
244 All images (avatar, banner and background) can be reset to the default by sending an empty string ("") instead of a file.
245
246 ### Pleroma Settings Store
247
248 Pleroma has mechanism that allows frontends to save blobs of json for each user on the backend. This can be used to save frontend-specific settings for a user that the backend does not need to know about.
249
250 The parameter should have a form of `{frontend_name: {...}}`, with `frontend_name` identifying your type of client, e.g. `pleroma_fe`. It will overwrite everything under this property, but will not overwrite other frontend's settings.
251
252 This information is returned in the `/api/v1/accounts/verify_credentials` endpoint.
253
254 ## Authentication
255
256 *Pleroma supports refreshing tokens.*
257
258 `POST /oauth/token`
259
260 Post here request with `grant_type=refresh_token` to obtain new access token. Returns an access token.
261
262 ## Account Registration
263
264 `POST /api/v1/accounts`
265
266 Has these additional parameters (which are the same as in Pleroma-API):
267
268 - `fullname`: optional
269 - `bio`: optional
270 - `captcha_solution`: optional, contains provider-specific captcha solution,
271 - `captcha_token`: optional, contains provider-specific captcha token
272 - `captcha_answer_data`: optional, contains provider-specific captcha data
273 - `token`: invite token required when the registrations aren't public.
274
275 ## Instance
276
277 `GET /api/v1/instance` has additional fields
278
279 - `max_toot_chars`: The maximum characters per post
280 - `chat_limit`: The maximum characters per chat message
281 - `description_limit`: The maximum characters per image description
282 - `poll_limits`: The limits of polls
283 - `upload_limit`: The maximum upload file size
284 - `avatar_upload_limit`: The same for avatars
285 - `background_upload_limit`: The same for backgrounds
286 - `banner_upload_limit`: The same for banners
287 - `background_image`: A background image that frontends can use
288 - `pleroma.metadata.features`: A list of supported features
289 - `pleroma.metadata.federation`: The federation restrictions of this instance
290 - `pleroma.metadata.fields_limits`: A list of values detailing the length and count limitation for various instance-configurable fields.
291 - `pleroma.metadata.post_formats`: A list of the allowed post format types
292 - `vapid_public_key`: The public key needed for push messages
293
294 ## Push Subscription
295
296 `POST /api/v1/push/subscription`
297 `PUT /api/v1/push/subscription`
298
299 Permits these additional alert types:
300
301 - pleroma:chat_mention
302 - pleroma:emoji_reaction
303
304 ## Markers
305
306 Has these additional fields under the `pleroma` object:
307
308 - `unread_count`: contains number unread notifications
309
310 ## Streaming
311
312 ### Chats
313
314 There is an additional `user:pleroma_chat` stream. Incoming chat messages will make the current chat be sent to this `user` stream. The `event` of an incoming chat message is `pleroma:chat_update`. The payload is the updated chat with the incoming chat message in the `last_message` field.
315
316 ### Remote timelines
317
318 For viewing remote server timelines, there are `public:remote` and `public:remote:media` streams. Each of these accept a parameter like `?instance=lain.com`.
319
320 ### Follow relationships updates
321
322 Pleroma streams follow relationships updates as `pleroma:follow_relationships_update` events to the `user` stream.
323
324 The message payload consist of:
325
326 - `state`: a relationship state, one of `follow_pending`, `follow_accept` or `follow_reject`.
327
328 - `follower` and `following` maps with following fields:
329 - `id`: user ID
330 - `follower_count`: follower count
331 - `following_count`: following count
332
333 ## User muting and thread muting
334
335 Both user muting and thread muting can be done for only a certain time by adding an `expires_in` parameter to the API calls and giving the expiration time in seconds.
336
337 ## Not implemented
338
339 Pleroma is generally compatible with the Mastodon 2.7.2 API, but some newer features and non-essential features are omitted. These features usually return an HTTP 200 status code, but with an empty response. While they may be added in the future, they are considered low priority.
340
341 ### Suggestions
342
343 *Added in Mastodon 2.4.3*
344
345 - `GET /api/v1/suggestions`: Returns an empty array, `[]`
346
347 ### Trends
348
349 *Added in Mastodon 3.0.0*
350
351 - `GET /api/v1/trends`: Returns an empty array, `[]`
352
353 ### Identity proofs
354
355 *Added in Mastodon 2.8.0*
356
357 - `GET /api/v1/identity_proofs`: Returns an empty array, `[]`
358
359 ### Endorsements
360
361 *Added in Mastodon 2.5.0*
362
363 - `GET /api/v1/endorsements`: Returns an empty array, `[]`
364
365 ### Profile directory
366
367 *Added in Mastodon 3.0.0*
368
369 - `GET /api/v1/directory`: Returns HTTP 404
370
371 ### Featured tags
372
373 *Added in Mastodon 3.0.0*
374
375 - `GET /api/v1/featured_tags`: Returns HTTP 404