git.squeep.com Git - akkoma/blob - docs/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 sortable strings
   8
   9 ## Attachment cap
  10
  11 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.
  12
  13 ## Timelines
  14
  15 Adding the parameter `with_muted=true` to the timeline queries will also return activities by muted (not by blocked!) users.
  16
  17 ## Statuses
  18
  19 Has these additional fields under the `pleroma` object:
  20
  21 - `local`: true if the post was made on the local instance.
  22 - `conversation_id`: the ID of the conversation the status is associated with (if any)
  23 - `content`: a map consisting of alternate representations of the `content` property with the key being it's mimetype. Currently the only alternate representation supported is `text/plain`
  24 - `spoiler_text`: a map consisting of alternate representations of the `spoiler_text` property with the key being it's mimetype. Currently the only alternate representation supported is `text/plain`
  25
  26 ## Attachments
  27
  28 Has these additional fields under the `pleroma` object:
  29
  30 - `mime_type`: mime type of the attachment.
  31
  32 ## Accounts
  33
  34 - `/api/v1/accounts/:id`: The `id` parameter can also be the `nickname` of the user. This only works in this endpoint, not the deeper nested ones for following etc.
  35
  36 Has these additional fields under the `pleroma` object:
  37
  38 - `tags`: Lists an array of tags for the user
  39 - `relationship{}`: Includes fields as documented for Mastodon API https://docs.joinmastodon.org/api/entities/#relationship
  40 - `is_moderator`: boolean, true if user is a moderator
  41 - `is_admin`: boolean, true if user is an admin
  42 - `confirmation_pending`: boolean, true if a new user account is waiting on email confirmation to be activated
  43
  44 ## Notifications
  45
  46 Has these additional fields under the `pleroma` object:
  47
  48 - `is_seen`: true if the notification was read by the user
  49
  50 ## POST `/api/v1/statuses`
  51
  52 Additional parameters can be added to the JSON body/Form data:
  53
  54 - `preview`: boolean, if set to `true` the post won't be actually posted, but the status entitiy would still be rendered back. This could be useful for previewing rich text/custom emoji, for example.