differences_in_mastoapi_responses.md 17.3 KB
Newer Older
1
2
# Differences in Mastodon API responses from vanilla Mastodon

Maksim's avatar
Maksim committed
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
6
## Flake IDs

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

lain's avatar
lain committed
9
10
11
## Timelines

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
18
Adding the parameter `instance=lain.com` to the public timeline will show only statuses originating from `lain.com` (or any remote instance).

19
Home, public, hashtag & list timelines accept these parameters:
20

21
22
- `only_media`: show only statuses with media attached
- `local`: show only local statuses
23
- `remote`: show only remote statuses
24

25
26
## Statuses

minibikini's avatar
minibikini committed
27
- `visibility`: has additional possible values `list` and `local` (for local-only statuses)
minibikini's avatar
minibikini committed
28

29
Has these additional fields under the `pleroma` object:
30

minibikini's avatar
minibikini committed
31
- `local`: true if the post was made on the local instance
lain's avatar
lain committed
32
33
- `conversation_id`: the ID of the AP context the status is associated with (if any)
- `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
36
- `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`
- `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`
lain's avatar
lain committed
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
lain's avatar
lain committed
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.
Alexander Strizhakov's avatar
Alexander Strizhakov committed
41
- `pinned_at`: a datetime (iso8601) when status was pinned, `null` otherwise.
42

43
44
45
46
47
48
## Scheduled statuses

Has these additional fields in `params`:

- `expires_in`: the number of seconds the posted activity should expire in.

49
## Media Attachments
50
51
52
53
54

Has these additional fields under the `pleroma` object:

- `mime_type`: mime type of the attachment.

55
56
57
58
59
60
61
62
### Attachment cap

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.

### Limitations

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.

63
64
## Accounts

65
66
67
68
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.

- `/api/v1/accounts/:id`
- `/api/v1/accounts/:id/statuses`
69

70
71
72
73
74
75
76
77
78
79
`/api/v1/accounts/:id/statuses` endpoint accepts these parameters:

- `pinned`: include only pinned statuses
- `tagged`: with tag
- `only_media`: include only statuses with media attached
- `with_muted`: include statuses/reactions from muted accounts
- `exclude_reblogs`: exclude reblogs
- `exclude_replies`: exclude replies
- `exclude_visibilities`: exclude visibilities

80
81
82
83
84
85
86
Endpoints which accept `with_relationships` parameter:

- `/api/v1/accounts/:id`
- `/api/v1/accounts/:id/followers`
- `/api/v1/accounts/:id/following`
- `/api/v1/mutes`

87
88
Has these additional fields under the `pleroma` object:

89
90
- `ap_id`: nullable URL string, ActivityPub id of the user
- `background_image`: nullable URL string, background image of the user
91
- `tags`: Lists an array of tags for the user
92
- `relationship` (object): Includes fields as documented for Mastodon API https://docs.joinmastodon.org/entities/relationship/
93
94
- `is_moderator`: boolean, nullable,  true if user is a moderator
- `is_admin`: boolean, nullable, true if user is an admin
95
- `confirmation_pending`: boolean, true if a new user account is waiting on email confirmation to be activated
96
- `hide_favorites`: boolean, true when the user has hiding favorites enabled
97
98
- `hide_followers`: boolean, true when the user has follower hiding enabled
- `hide_follows`: boolean, true when the user has follow hiding enabled
99
100
- `hide_followers_count`: boolean, true when the user has follower stat hiding enabled
- `hide_follows_count`: boolean, true when the user has follow stat hiding enabled
101
- `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`
102
- `chat_token`: The token needed for Pleroma shoutbox. Only returned in `/api/v1/accounts/verify_credentials`
103
- `deactivated`: boolean, true when the user is deactivated
104
- `allow_following_move`: boolean, true when the user allows automatically follow moved following accounts
105
- `unread_conversation_count`: The count of unread conversations. Only returned to the account owner.
106
- `unread_notifications_count`: The count of unread notifications. Only returned to the account owner.
107
- `notification_settings`: object, can be absent. See `/api/v1/pleroma/notification_settings` for the parameters/keys returned.
108
- `accepts_chat_messages`: boolean, but can be null if we don't have that information about a user
Haelwenn's avatar
Haelwenn committed
109
- `favicon`: nullable URL string, Favicon image of the user's instance
rinpatch's avatar
rinpatch committed
110
111
112
113
114
115
116

### Source

Has these additional fields under the `pleroma` object:

- `show_role`: boolean, nullable, true when the user wants his role (e.g admin, moderator) to be shown
- `no_rich_text` - boolean, nullable, true when html tags are stripped from all statuses requested from the API
117
- `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)
118
- `actor_type`: string, the type of this account.
119

120
121
122
123
124
125
## Conversations

Has an additional field under the `pleroma` object:

- `recipients`: The list of the recipients of this Conversation. These will be addressed when replying to this conversation.

126
127
128
129
130
131
## GET `/api/v1/conversations`

Accepts additional parameters:

- `recipients`: Only return conversations with the given recipients (a list of user ids). Usage example: `GET /api/v1/conversations?recipients[]=1&recipients[]=2`

132
133
134
135
136
137
## Account Search

Behavior has changed:

- `/api/v1/accounts/search`: Does not require authentication

138
139
140
## Search (global)

Unlisted posts are available in search results, they are considered to be public posts that shouldn't be shown in local/federated timeline.
141

142
143
144
145
146
## Notifications

Has these additional fields under the `pleroma` object:

- `is_seen`: true if the notification was read by the user
rinpatch's avatar
rinpatch committed
147

148
149
150
151
152
153
### Move Notification

The `type` value is `move`. Has an additional field:

- `target`: new account

lain's avatar
lain committed
154
### EmojiReact Notification
155
156
157
158
159
160
161

The `type` value is `pleroma:emoji_reaction`. Has these fields:

- `emoji`: The used emoji
- `account`: The account of the user who reacted
- `status`: The status that was reacted on

Ilja's avatar
Ilja committed
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
### ChatMention Notification (not default)

This notification has to be requested explicitly.

The `type` value is `pleroma:chat_mention`

- `account`: The account who sent the message
- `chat_message`: The chat message

### Report Notification (not default)

This notification has to be requested explicitly.

The `type` value is `pleroma:report`

- `account`: The account who reported
- `report`: The report

180
181
182
183
184
## GET `/api/v1/notifications`

Accepts additional parameters:

- `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`.
Ilja's avatar
Ilja committed
185
- `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`.
186

187
188
189
190
191
192
193
194
195
196
197
198
## DELETE `/api/v1/notifications/destroy_multiple`

An endpoint to delete multiple statuses by IDs.

Required parameters:

- `ids`: array of activity ids

Usage example: `DELETE /api/v1/notifications/destroy_multiple/?ids[]=1&ids[]=2`.

Returns on success: 200 OK `{}`

rinpatch's avatar
rinpatch committed
199
200
## POST `/api/v1/statuses`

201
Additional parameters can be added to the JSON body/Form data:
rinpatch's avatar
rinpatch committed
202

203
- `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.
204
- `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.
205
- `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.
minibikini's avatar
minibikini committed
206
- `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`.
lain's avatar
lain committed
207
- `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.
208
- `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`.
209

210
211
212
213
214
215
216
217
218
219
220
221
## GET `/api/v1/statuses`

An endpoint to get multiple statuses by IDs.

Required parameters:

- `ids`: array of activity ids

Usage example: `GET /api/v1/statuses/?ids[]=1&ids[]=2`.

Returns: array of Status.

minibikini's avatar
minibikini committed
222
223
The maximum number of statuses is limited to 100 per request.

224
## PATCH `/api/v1/accounts/update_credentials`
225
226
227
228
229
230

Additional parameters can be added to the JSON body/Form data:

- `no_rich_text` - if true, html tags are stripped from all statuses requested from the API
- `hide_followers` - if true, user's followers will be hidden
- `hide_follows` - if true, user's follows will be hidden
231
232
- `hide_followers_count` - if true, user's follower count will be hidden
- `hide_follows_count` - if true, user's follow count will be hidden
233
234
- `hide_favorites` - if true, user's favorites timeline will be hidden
- `show_role` - if true, user's role (e.g admin, moderator) will be exposed to anyone in the API
235
- `default_scope` - the scope returned under `privacy` key in Source subentity
236
- `pleroma_settings_store` - Opaque user settings to be saved on the backend.
237
- `skip_thread_containment` - if true, skip filtering out broken threads
238
- `allow_following_move` - if true, allows automatically follow moved following accounts
Alex Gleason's avatar
Alex Gleason committed
239
- `also_known_as` - array of ActivityPub IDs, needed for following move
lain's avatar
lain committed
240
- `pleroma_background_image` - sets the background image of the user. Can be set to "" (an empty string) to reset.
241
- `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).
242
- `actor_type` - the type of this account.
243
- `accepts_chat_messages` - if false, this account will reject all chat messages.
244

lain's avatar
lain committed
245
246
All images (avatar, banner and background) can be reset to the default by sending an empty string ("") instead of a file.

247
### Pleroma Settings Store
minibikini's avatar
minibikini committed
248

249
250
251
252
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.

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.

253
This information is returned in the `/api/v1/accounts/verify_credentials` endpoint.
Maksim's avatar
Maksim committed
254
255
256

## Authentication

minibikini's avatar
minibikini committed
257
*Pleroma supports refreshing tokens.*
Maksim's avatar
Maksim committed
258

259
### POST `/oauth/token`
minibikini's avatar
minibikini committed
260

261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
You can obtain access tokens for a user in a few additional ways.

#### Refreshing a token

To obtain a new access token from a refresh token, pass `grant_type=refresh_token` with the following extra parameters:

- `refresh_token`: The refresh token.

#### Getting a token with a password

To obtain a token from a user's password, pass `grant_type=password` with the following extra parameters:

- `username`: Username to authenticate.
- `password`: The user's password.

#### Response body

Additional fields are returned in the response:

- `id`: The primary key of this token in Pleroma's database.
- `me` (user tokens only): The ActivityPub ID of the user who owns the token.
282
283

## Account Registration
minibikini's avatar
minibikini committed
284

285
286
`POST /api/v1/accounts`

feld's avatar
feld committed
287
Has these additional parameters (which are the same as in Pleroma-API):
minibikini's avatar
minibikini committed
288

Maksim's avatar
Maksim committed
289
290
291
292
- `fullname`: optional
- `bio`: optional
- `captcha_solution`: optional, contains provider-specific captcha solution,
- `captcha_token`: optional, contains provider-specific captcha token
293
- `captcha_answer_data`: optional, contains provider-specific captcha data
Maksim's avatar
Maksim committed
294
- `token`: invite token required when the registrations aren't public.
295

296
297
298
299
300
## Instance

`GET /api/v1/instance` has additional fields

- `max_toot_chars`: The maximum characters per post
lain's avatar
lain committed
301
302
- `chat_limit`: The maximum characters per chat message
- `description_limit`: The maximum characters per image description
303
304
305
306
307
- `poll_limits`: The limits of polls
- `upload_limit`: The maximum upload file size
- `avatar_upload_limit`: The same for avatars
- `background_upload_limit`: The same for backgrounds
- `banner_upload_limit`: The same for banners
lain's avatar
lain committed
308
- `background_image`: A background image that frontends can use
309
310
- `pleroma.metadata.features`: A list of supported features
- `pleroma.metadata.federation`: The federation restrictions of this instance
311
- `pleroma.metadata.fields_limits`: A list of values detailing the length and count limitation for various instance-configurable fields.
312
- `pleroma.metadata.post_formats`: A list of the allowed post format types
313
- `vapid_public_key`: The public key needed for push messages
314

315
316
317
318
319
320
321
322
323
324
## Push Subscription

`POST /api/v1/push/subscription`
`PUT /api/v1/push/subscription`

Permits these additional alert types:

- pleroma:chat_mention
- pleroma:emoji_reaction

325
326
327
328
329
## Markers

Has these additional fields under the `pleroma` object:

- `unread_count`: contains number unread notifications
lain's avatar
lain committed
330
331
332

## Streaming

333
334
### Chats

lain's avatar
lain committed
335
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.
336

337
338
### Remote timelines

339
340
For viewing remote server timelines, there are `public:remote` and `public:remote:media` streams. Each of these accept a parameter like `?instance=lain.com`.

341
342
### Follow relationships updates

minibikini's avatar
minibikini committed
343
Pleroma streams follow relationships updates as `pleroma:follow_relationships_update` events to the `user` stream.
344

minibikini's avatar
minibikini committed
345
The message payload consist of:
346
347
348
349
350
351
352
353

- `state`: a relationship state, one of `follow_pending`, `follow_accept` or `follow_reject`.

- `follower` and `following` maps with following fields:
  - `id`: user ID
  - `follower_count`: follower count
  - `following_count`: following count

lain's avatar
lain committed
354
355
356
357
## User muting and thread muting

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.

358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
## Not implemented

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.

### Suggestions

*Added in Mastodon 2.4.3*

- `GET /api/v1/suggestions`: Returns an empty array, `[]`

### Trends

*Added in Mastodon 3.0.0*

- `GET /api/v1/trends`: Returns an empty array, `[]`

### Identity proofs

*Added in Mastodon 2.8.0*

- `GET /api/v1/identity_proofs`: Returns an empty array, `[]`

### Endorsements

*Added in Mastodon 2.5.0*

- `GET /api/v1/endorsements`: Returns an empty array, `[]`

### Profile directory

*Added in Mastodon 3.0.0*

- `GET /api/v1/directory`: Returns HTTP 404

### Featured tags

*Added in Mastodon 3.0.0*

- `GET /api/v1/featured_tags`: Returns HTTP 404