[{"data":1,"prerenderedAt":1038},["ShallowReactive",2],{"docs-nav":3,"docs-page-collections":818},[4,41,444],{"title":5,"items":6},"Getting started",[7,12,26,31,36],{"title":8,"to":9,"icon":10,"children":11},"Introduction","\u002Fapi","book-open",[],{"title":13,"to":14,"icon":15,"children":16},"Authentication","\u002Fapi\u002Fauthentication","key",[17,22],{"id":18,"title":19,"method":20,"path":21},"register-app","Register an app","POST","\u002Fapi\u002Fv1\u002Fapps",{"id":23,"title":24,"method":20,"path":25},"get-token","Get a token","\u002Foauth\u002Ftoken",{"title":27,"to":28,"icon":29,"children":30},"Pagination","\u002Fapi\u002Fpagination","square-3-stack-3d",[],{"title":32,"to":33,"icon":34,"children":35},"Errors","\u002Fapi\u002Ferrors","exclamation-triangle",[],{"title":37,"to":38,"icon":39,"children":40},"Pixelfed entities","\u002Fapi\u002Fpixelfed-entities","arrows-right-left",[],{"title":42,"items":43},"Resources",[44,86,200,289,309,337,346,379,396],{"title":45,"to":46,"icon":47,"children":48},"Instance","\u002Fapi\u002Finstance","server",[49,54,58,62,66,70,74,78,82],{"id":50,"title":51,"method":52,"path":53},"get-instance-v2","Get instance (v2)","GET","\u002Fapi\u002Fv2\u002Finstance",{"id":55,"title":56,"method":52,"path":57},"get-instance-v1","Get instance (v1)","\u002Fapi\u002Fv1\u002Finstance",{"id":59,"title":60,"method":52,"path":61},"get-config","Get Pixelfed config","\u002Fapi\u002Fv2.1\u002Fconfig",{"id":63,"title":64,"method":52,"path":65},"list-peers","List known peers","\u002Fapi\u002Fv1\u002Finstance\u002Fpeers",{"id":67,"title":68,"method":52,"path":69},"list-custom-emojis","List custom emoji","\u002Fapi\u002Fv1\u002Fcustom_emojis",{"id":71,"title":72,"method":52,"path":73},"list-announcements","List announcements","\u002Fapi\u002Fv1\u002Fannouncements",{"id":75,"title":76,"method":52,"path":77},"get-streaming-config","Get streaming config","\u002Fapi\u002Fv2\u002Fstreaming\u002Fconfig",{"id":79,"title":80,"method":52,"path":81},"get-push-gateway-state","Get push gateway state","\u002Fapi\u002Fv1.1\u002Fnag\u002Fstate",{"id":83,"title":84,"method":52,"path":85},"health-check","Health check","\u002Fapi\u002Fservice\u002Fhealth-check",{"title":87,"to":88,"icon":89,"children":90},"Accounts","\u002Fapi\u002Faccounts","user",[91,95,100,104,108,112,116,120,124,128,132,136,140,144,148,152,156,160,164,168,172,176,180,184,188,192,196],{"id":92,"title":93,"method":52,"path":94},"verify-credentials","Verify credentials","\u002Fapi\u002Fv1\u002Faccounts\u002Fverify_credentials",{"id":96,"title":97,"method":98,"path":99},"update-credentials","Update profile","PATCH","\u002Fapi\u002Fv1\u002Faccounts\u002Fupdate_credentials",{"id":101,"title":102,"method":52,"path":103},"get-account","Get an account","\u002Fapi\u002Fv1\u002Faccounts\u002F{id}",{"id":105,"title":106,"method":52,"path":107},"lookup-account","Look up an account","\u002Fapi\u002Fv1\u002Faccounts\u002Flookup",{"id":109,"title":110,"method":52,"path":111},"search-accounts","Search accounts","\u002Fapi\u002Fv1\u002Faccounts\u002Fsearch",{"id":113,"title":114,"method":52,"path":115},"get-account-statuses","List an account's posts","\u002Fapi\u002Fv1\u002Faccounts\u002F{id}\u002Fstatuses",{"id":117,"title":118,"method":52,"path":119},"get-account-followers","List followers","\u002Fapi\u002Fv1\u002Faccounts\u002F{id}\u002Ffollowers",{"id":121,"title":122,"method":52,"path":123},"get-account-following","List following","\u002Fapi\u002Fv1\u002Faccounts\u002F{id}\u002Ffollowing",{"id":125,"title":126,"method":52,"path":127},"get-relationships","Check relationships","\u002Fapi\u002Fv1\u002Faccounts\u002Frelationships",{"id":129,"title":130,"method":20,"path":131},"follow-account","Follow an account","\u002Fapi\u002Fv1\u002Faccounts\u002F{id}\u002Ffollow",{"id":133,"title":134,"method":20,"path":135},"unfollow-account","Unfollow an account","\u002Fapi\u002Fv1\u002Faccounts\u002F{id}\u002Funfollow",{"id":137,"title":138,"method":20,"path":139},"remove-from-followers","Remove a follower","\u002Fapi\u002Fv1\u002Faccounts\u002F{id}\u002Fremove_from_followers",{"id":141,"title":142,"method":52,"path":143},"list-follow-requests","List follow requests","\u002Fapi\u002Fv1\u002Ffollow_requests",{"id":145,"title":146,"method":20,"path":147},"authorize-follow-request","Accept a follow request","\u002Fapi\u002Fv1\u002Ffollow_requests\u002F{id}\u002Fauthorize",{"id":149,"title":150,"method":20,"path":151},"reject-follow-request","Reject a follow request","\u002Fapi\u002Fv1\u002Ffollow_requests\u002F{id}\u002Freject",{"id":153,"title":154,"method":20,"path":155},"block-account","Block an account","\u002Fapi\u002Fv1\u002Faccounts\u002F{id}\u002Fblock",{"id":157,"title":158,"method":20,"path":159},"unblock-account","Unblock an account","\u002Fapi\u002Fv1\u002Faccounts\u002F{id}\u002Funblock",{"id":161,"title":162,"method":20,"path":163},"mute-account","Mute an account","\u002Fapi\u002Fv1\u002Faccounts\u002F{id}\u002Fmute",{"id":165,"title":166,"method":20,"path":167},"unmute-account","Unmute an account","\u002Fapi\u002Fv1\u002Faccounts\u002F{id}\u002Funmute",{"id":169,"title":170,"method":52,"path":171},"get-preferences","Get preferences","\u002Fapi\u002Fv1\u002Fpreferences",{"id":173,"title":174,"method":52,"path":175},"list-suggestions","List follow suggestions","\u002Fapi\u002Fv1\u002Fsuggestions",{"id":177,"title":178,"method":52,"path":179},"list-endorsements","List featured accounts","\u002Fapi\u002Fv1\u002Fendorsements",{"id":181,"title":182,"method":20,"path":183},"endorse-account","Feature an account","\u002Fapi\u002Fv1\u002Faccounts\u002F{id}\u002Fpin",{"id":185,"title":186,"method":20,"path":187},"unendorse-account","Unfeature an account","\u002Fapi\u002Fv1\u002Faccounts\u002F{id}\u002Funpin",{"id":189,"title":190,"method":52,"path":191},"list-lists","List your lists","\u002Fapi\u002Fv1\u002Flists",{"id":193,"title":194,"method":52,"path":195},"get-account-lists","List lists containing an account","\u002Fapi\u002Fv1\u002Faccounts\u002F{id}\u002Flists",{"id":197,"title":198,"method":52,"path":199},"get-list-accounts","List accounts in a list","\u002Fapi\u002Fv1\u002Flists\u002F{id}\u002Faccounts",{"title":201,"to":202,"icon":203,"children":204},"Statuses","\u002Fapi\u002Fstatuses","pencil-square",[205,209,213,217,221,225,229,233,237,241,245,249,253,257,261,265,269,273,277,281,285],{"id":206,"title":207,"method":52,"path":208},"get-status","Get a post","\u002Fapi\u002Fv1\u002Fstatuses\u002F{id}",{"id":210,"title":211,"method":52,"path":212},"get-status-context","Get comments and parent","\u002Fapi\u002Fv1\u002Fstatuses\u002F{id}\u002Fcontext",{"id":214,"title":215,"method":52,"path":216},"get-status-card","Get a link preview","\u002Fapi\u002Fv1\u002Fstatuses\u002F{id}\u002Fcard",{"id":218,"title":219,"method":52,"path":220},"get-status-history","Get edit history","\u002Fapi\u002Fv1\u002Fstatuses\u002F{id}\u002Fhistory",{"id":222,"title":223,"method":20,"path":224},"create-post","Create a post","\u002Fapi\u002Fv1\u002Fstatuses",{"id":226,"title":227,"method":20,"path":228},"create-post-with-file","Create a post in one request","\u002Fapi\u002Fv1.1\u002Fstatus\u002Fcreate",{"id":230,"title":231,"method":232,"path":208},"edit-post","Edit a post","PUT",{"id":234,"title":235,"method":232,"path":236},"set-interaction-policy","Set who can quote a post","\u002Fapi\u002Fv1\u002Fstatuses\u002F{id}\u002Finteraction_policy",{"id":238,"title":239,"method":240,"path":208},"delete-post","Delete a post","DELETE",{"id":242,"title":243,"method":52,"path":244},"list-favourites","List liked posts","\u002Fapi\u002Fv1\u002Ffavourites",{"id":246,"title":247,"method":52,"path":248},"list-favourited-by","List who liked a post","\u002Fapi\u002Fv1\u002Fstatuses\u002F{id}\u002Ffavourited_by",{"id":250,"title":251,"method":20,"path":252},"like-post","Like a post","\u002Fapi\u002Fv1\u002Fstatuses\u002F{id}\u002Ffavourite",{"id":254,"title":255,"method":20,"path":256},"unlike-post","Unlike a post","\u002Fapi\u002Fv1\u002Fstatuses\u002F{id}\u002Funfavourite",{"id":258,"title":259,"method":52,"path":260},"list-reblogged-by","List who shared a post","\u002Fapi\u002Fv1\u002Fstatuses\u002F{id}\u002Freblogged_by",{"id":262,"title":263,"method":20,"path":264},"share-post","Share a post","\u002Fapi\u002Fv1\u002Fstatuses\u002F{id}\u002Freblog",{"id":266,"title":267,"method":20,"path":268},"unshare-post","Undo a share","\u002Fapi\u002Fv1\u002Fstatuses\u002F{id}\u002Funreblog",{"id":270,"title":271,"method":52,"path":272},"list-bookmarks","List bookmarks","\u002Fapi\u002Fv1\u002Fbookmarks",{"id":274,"title":275,"method":20,"path":276},"bookmark-post","Bookmark a post","\u002Fapi\u002Fv1\u002Fstatuses\u002F{id}\u002Fbookmark",{"id":278,"title":279,"method":20,"path":280},"unbookmark-post","Remove a bookmark","\u002Fapi\u002Fv1\u002Fstatuses\u002F{id}\u002Funbookmark",{"id":282,"title":283,"method":20,"path":284},"pin-post","Pin a post to your profile","\u002Fapi\u002Fv1\u002Fstatuses\u002F{id}\u002Fpin",{"id":286,"title":287,"method":20,"path":288},"unpin-post","Unpin a post","\u002Fapi\u002Fv1\u002Fstatuses\u002F{id}\u002Funpin",{"title":290,"to":291,"icon":292,"children":293},"Media","\u002Fapi\u002Fmedia","photo",[294,298,302,306],{"id":295,"title":296,"method":20,"path":297},"upload-media","Upload media","\u002Fapi\u002Fv2\u002Fmedia",{"id":299,"title":300,"method":20,"path":301},"upload-media-v1","Upload media (v1)","\u002Fapi\u002Fv1\u002Fmedia",{"id":303,"title":304,"method":52,"path":305},"get-media","Get an upload","\u002Fapi\u002Fv1\u002Fmedia\u002F{id}",{"id":307,"title":308,"method":232,"path":305},"update-media","Update alt text",{"title":310,"to":311,"icon":312,"children":313},"Timelines","\u002Fapi\u002Ftimelines","queue-list",[314,318,322,326,330,334],{"id":315,"title":316,"method":52,"path":317},"home-timeline","Home timeline","\u002Fapi\u002Fv1\u002Ftimelines\u002Fhome",{"id":319,"title":320,"method":52,"path":321},"home-timeline-v1-1","Home timeline (Pixelfed path)","\u002Fapi\u002Fv1.1\u002Faccounts\u002Ftimelines\u002Fhome",{"id":323,"title":324,"method":52,"path":325},"public-timeline","Public timeline","\u002Fapi\u002Fv1\u002Ftimelines\u002Fpublic",{"id":327,"title":328,"method":52,"path":329},"hashtag-timeline","Hashtag timeline","\u002Fapi\u002Fv1\u002Ftimelines\u002Ftag\u002F{hashtag}",{"id":331,"title":332,"method":52,"path":333},"get-markers","Get a read marker","\u002Fapi\u002Fv1\u002Fmarkers",{"id":335,"title":336,"method":20,"path":333},"save-markers","Save a read marker",{"title":338,"to":339,"icon":340,"children":341},"Notifications","\u002Fapi\u002Fnotifications","bell",[342],{"id":343,"title":344,"method":52,"path":345},"list-notifications","List notifications","\u002Fapi\u002Fv1\u002Fnotifications",{"title":347,"to":348,"icon":349,"children":350},"Search & hashtags","\u002Fapi\u002Fsearch","magnifying-glass",[351,355,359,363,367,371,375],{"id":352,"title":353,"method":52,"path":354},"search","Search","\u002Fapi\u002Fv2\u002Fsearch",{"id":356,"title":357,"method":52,"path":358},"get-trends","Trending hashtags","\u002Fapi\u002Fv1\u002Ftrends",{"id":360,"title":361,"method":52,"path":362},"get-hashtag","Get a hashtag","\u002Fapi\u002Fv1\u002Ftags\u002F{id}",{"id":364,"title":365,"method":52,"path":366},"related-hashtags","Related hashtags","\u002Fapi\u002Fv1\u002Ftags\u002F{id}\u002Frelated",{"id":368,"title":369,"method":52,"path":370},"list-followed-hashtags","List followed hashtags","\u002Fapi\u002Fv1\u002Ffollowed_tags",{"id":372,"title":373,"method":20,"path":374},"follow-hashtag","Follow a hashtag","\u002Fapi\u002Fv1\u002Ftags\u002F{id}\u002Ffollow",{"id":376,"title":377,"method":20,"path":378},"unfollow-hashtag","Unfollow a hashtag","\u002Fapi\u002Fv1\u002Ftags\u002F{id}\u002Funfollow",{"title":380,"to":381,"icon":382,"children":383},"Conversations","\u002Fapi\u002Fconversations","chat-bubble-left-right",[384,388,392],{"id":385,"title":386,"method":52,"path":387},"list-conversations","List conversations","\u002Fapi\u002Fv1\u002Fconversations",{"id":389,"title":390,"method":20,"path":391},"mark-conversation-read","Mark a conversation as read","\u002Fapi\u002Fv1\u002Fconversations\u002F{id}\u002Fread",{"id":393,"title":394,"method":240,"path":395},"delete-conversation","Remove a conversation","\u002Fapi\u002Fv1\u002Fconversations\u002F{id}",{"title":397,"to":398,"icon":399,"children":400},"Blocks, mutes & filters","\u002Fapi\u002Fsafety","shield-check",[401,405,409,413,416,419,423,427,431,434,437,440],{"id":402,"title":403,"method":52,"path":404},"list-blocks","List blocked accounts","\u002Fapi\u002Fv1\u002Fblocks",{"id":406,"title":407,"method":52,"path":408},"list-mutes","List muted accounts","\u002Fapi\u002Fv1\u002Fmutes",{"id":410,"title":411,"method":52,"path":412},"list-domain-blocks","List blocked domains","\u002Fapi\u002Fv1\u002Fdomain_blocks",{"id":414,"title":415,"method":20,"path":412},"block-domain","Block a domain",{"id":417,"title":418,"method":240,"path":412},"unblock-domain","Unblock a domain",{"id":420,"title":421,"method":52,"path":422},"list-filters-v1","List filters (v1)","\u002Fapi\u002Fv1\u002Ffilters",{"id":424,"title":425,"method":52,"path":426},"list-filters","List filters","\u002Fapi\u002Fv2\u002Ffilters",{"id":428,"title":429,"method":52,"path":430},"get-filter","Get a filter","\u002Fapi\u002Fv2\u002Ffilters\u002F{id}",{"id":432,"title":433,"method":20,"path":426},"create-filter","Create a filter",{"id":435,"title":436,"method":232,"path":430},"update-filter","Update a filter",{"id":438,"title":439,"method":240,"path":430},"delete-filter","Delete a filter",{"id":441,"title":442,"method":20,"path":443},"report","Report content","\u002Fapi\u002Fv1.1\u002Freport",{"title":445,"items":446},"Pixelfed only",[447,484,576,621,658,722,739,756,777],{"title":448,"to":449,"icon":450,"children":451},"Collections","\u002Fapi\u002Fcollections","rectangle-stack",[452,456,460,464,468,472,476,480],{"id":453,"title":454,"method":52,"path":455},"list-collections","List an account's collections","\u002Fapi\u002Fv1.1\u002Fcollections\u002Faccounts\u002F{id}",{"id":457,"title":458,"method":52,"path":459},"list-own-collections","List your collections","\u002Fapi\u002Fv1.1\u002Fcollections\u002Fself",{"id":461,"title":462,"method":52,"path":463},"get-collection","Get a collection","\u002Fapi\u002Fv1.1\u002Fcollections\u002Fview\u002F{id}",{"id":465,"title":466,"method":52,"path":467},"list-collection-items","List collection posts","\u002Fapi\u002Fv1.1\u002Fcollections\u002Fitems\u002F{id}",{"id":469,"title":470,"method":20,"path":471},"update-collection","Update a collection","\u002Fapi\u002Fv1.1\u002Fcollections\u002Fupdate\u002F{id}",{"id":473,"title":474,"method":20,"path":475},"add-collection-item","Add a post to a collection","\u002Fapi\u002Fv1.1\u002Fcollections\u002Fadd",{"id":477,"title":478,"method":20,"path":479},"remove-collection-item","Remove a post from a collection","\u002Fapi\u002Fv1.1\u002Fcollections\u002Fremove",{"id":481,"title":482,"method":240,"path":483},"delete-collection","Delete a collection","\u002Fapi\u002Fv1.1\u002Fcollections\u002Fdelete\u002F{id}",{"title":485,"to":486,"icon":487,"children":488},"Direct messages","\u002Fapi\u002Fdirect","paper-airplane",[489,493,495,498,502,506,509,513,516,520,524,528,532,536,540,544,548,552,556,560,564,568,572],{"id":490,"title":491,"method":52,"path":492},"get-unread-count","Get unread counts","\u002Fapi\u002Fv1.1\u002Fdirect\u002Funread_count",{"id":385,"title":386,"method":52,"path":494},"\u002Fapi\u002Fv1.1\u002Fdirect\u002Fconversations",{"id":496,"title":497,"method":20,"path":494},"start-conversation","Start a conversation",{"id":499,"title":500,"method":52,"path":501},"get-conversation","Get a conversation","\u002Fapi\u002Fv1.1\u002Fdirect\u002Fconversations\u002F{id}",{"id":503,"title":504,"method":52,"path":505},"list-messages","List messages","\u002Fapi\u002Fv1.1\u002Fdirect\u002Fconversations\u002F{id}\u002Fmessages",{"id":507,"title":508,"method":20,"path":505},"send-message","Send a message",{"id":510,"title":511,"method":240,"path":512},"delete-message","Delete a message","\u002Fapi\u002Fv1.1\u002Fdirect\u002Fconversations\u002F{id}\u002Fmessages\u002F{messageId}",{"id":389,"title":514,"method":20,"path":515},"Mark a conversation read","\u002Fapi\u002Fv1.1\u002Fdirect\u002Fconversations\u002F{id}\u002Fread",{"id":517,"title":518,"method":20,"path":519},"accept-request","Accept a message request","\u002Fapi\u002Fv1.1\u002Fdirect\u002Fconversations\u002F{id}\u002Faccept",{"id":521,"title":522,"method":20,"path":523},"mute-conversation","Mute a conversation","\u002Fapi\u002Fv1.1\u002Fdirect\u002Fconversations\u002F{id}\u002Fmute",{"id":525,"title":526,"method":20,"path":527},"unmute-conversation","Unmute a conversation","\u002Fapi\u002Fv1.1\u002Fdirect\u002Fconversations\u002F{id}\u002Funmute",{"id":529,"title":530,"method":20,"path":531},"hide-conversation","Hide a conversation","\u002Fapi\u002Fv1.1\u002Fdirect\u002Fconversations\u002F{id}\u002Fhide",{"id":533,"title":534,"method":20,"path":535},"unhide-conversation","Unhide a conversation","\u002Fapi\u002Fv1.1\u002Fdirect\u002Fconversations\u002F{id}\u002Funhide",{"id":537,"title":538,"method":20,"path":539},"leave-conversation","Leave a group","\u002Fapi\u002Fv1.1\u002Fdirect\u002Fconversations\u002F{id}\u002Fleave",{"id":541,"title":542,"method":52,"path":543},"list-mutuals","List mutuals to message","\u002Fapi\u002Fv1.1\u002Fdirect\u002Fcompose\u002Fmutuals",{"id":545,"title":546,"method":20,"path":547},"lookup-recipient","Look up a recipient","\u002Fapi\u002Fv1.1\u002Fdirect\u002Flookup",{"id":549,"title":550,"method":52,"path":551},"get-thread","Get a 1:1 thread (legacy)","\u002Fapi\u002Fv1.1\u002Fdirect\u002Fthread",{"id":553,"title":554,"method":20,"path":555},"send-thread-message","Send a 1:1 message (legacy)","\u002Fapi\u002Fv1.1\u002Fdirect\u002Fthread\u002Fsend",{"id":557,"title":558,"method":20,"path":559},"upload-thread-media","Send a photo or video (legacy)","\u002Fapi\u002Fv1.1\u002Fdirect\u002Fthread\u002Fmedia",{"id":561,"title":562,"method":20,"path":563},"mark-thread-read","Mark a 1:1 thread read (legacy)","\u002Fapi\u002Fv1.1\u002Fdirect\u002Fthread\u002Fread",{"id":565,"title":566,"method":240,"path":567},"delete-thread-message","Delete a message (legacy)","\u002Fapi\u002Fv1.1\u002Fdirect\u002Fthread\u002Fmessage",{"id":569,"title":570,"method":20,"path":571},"mute-thread","Mute a 1:1 thread (legacy)","\u002Fapi\u002Fv1.1\u002Fdirect\u002Fthread\u002Fmute",{"id":573,"title":574,"method":20,"path":575},"unmute-thread","Unmute a 1:1 thread (legacy)","\u002Fapi\u002Fv1.1\u002Fdirect\u002Fthread\u002Funmute",{"title":577,"to":578,"icon":579,"children":580},"Stories","\u002Fapi\u002Fstories","clock",[581,585,589,593,597,601,605,609,613,617],{"id":582,"title":583,"method":52,"path":584},"get-carousel","Get the stories carousel","\u002Fapi\u002Fv1.2\u002Fstories\u002Fcarousel",{"id":586,"title":587,"method":52,"path":588},"get-carousel-v1","Get the stories carousel (v1.1)","\u002Fapi\u002Fv1.1\u002Fstories\u002Fcarousel",{"id":590,"title":591,"method":20,"path":592},"publish-story","Publish a story","\u002Fapi\u002Fv1.2\u002Fstories\u002Fpublish",{"id":594,"title":595,"method":52,"path":596},"autocomplete-mentions","Autocomplete mentions","\u002Fapi\u002Fv1.2\u002Fstories\u002Fmention-autocomplete",{"id":598,"title":599,"method":20,"path":600},"upload-story","Upload story media (v1.1)","\u002Fapi\u002Fv1.1\u002Fstories\u002Fadd",{"id":602,"title":603,"method":20,"path":604},"publish-story-v1","Publish a story (v1.1)","\u002Fapi\u002Fv1.1\u002Fstories\u002Fpublish",{"id":606,"title":607,"method":20,"path":608},"mark-story-seen","Mark a story as seen","\u002Fapi\u002Fv1.1\u002Fstories\u002Fseen",{"id":610,"title":611,"method":52,"path":612},"list-story-viewers","List story viewers","\u002Fapi\u002Fv1.2\u002Fstories\u002Fviewers",{"id":614,"title":615,"method":20,"path":616},"reply-to-story","Reply to a story","\u002Fapi\u002Fv1.1\u002Fstories\u002Fcomment",{"id":618,"title":619,"method":20,"path":620},"delete-story","Delete a story","\u002Fapi\u002Fv1.1\u002Fstories\u002Fself-expire\u002F{id}",{"title":622,"to":623,"icon":624,"children":625},"Discover","\u002Fapi\u002Fdiscover","globe-alt",[626,630,634,638,642,646,650,654],{"id":627,"title":628,"method":52,"path":629},"get-trending-posts","Get trending posts","\u002Fapi\u002Fv1.1\u002Fdiscover\u002Fposts\u002Ftrending",{"id":631,"title":632,"method":52,"path":633},"get-trending-hashtags","Get trending hashtags","\u002Fapi\u002Fv1.1\u002Fdiscover\u002Fposts\u002Fhashtags",{"id":635,"title":636,"method":52,"path":637},"get-network-trending","Get network trending posts","\u002Fapi\u002Fv1.1\u002Fdiscover\u002Fposts\u002Fnetwork\u002Ftrending",{"id":639,"title":640,"method":52,"path":641},"get-discover-posts","Get suggested posts","\u002Fapi\u002Fv1\u002Fdiscover\u002Fposts",{"id":643,"title":644,"method":52,"path":645},"get-popular-accounts","Get popular accounts","\u002Fapi\u002Fv1.2\u002Fdiscover\u002Faccounts\u002Fpopular",{"id":647,"title":648,"method":52,"path":649},"get-popular-accounts-v1","Get popular accounts (v1.1)","\u002Fapi\u002Fv1.1\u002Fdiscover\u002Faccounts\u002Fpopular",{"id":651,"title":652,"method":52,"path":653},"get-landing-directory","Get the profile directory","\u002Fapi\u002Flanding\u002Fv1\u002Fdirectory",{"id":655,"title":656,"method":52,"path":657},"get-directory-listing","Get the server directory listing","\u002Fapi\u002Fv1.1\u002Fdirectory\u002Flisting",{"title":659,"to":660,"icon":661,"children":662},"Account settings","\u002Fapi\u002Faccount-settings","cog-6-tooth",[663,667,671,675,679,682,686,690,694,698,702,706,710,714,718],{"id":664,"title":665,"method":52,"path":666},"verify-app","Verify app credentials","\u002Fapi\u002Fv1\u002Fapps\u002Fverify_credentials",{"id":668,"title":669,"method":20,"path":670},"update-avatar","Update avatar","\u002Fapi\u002Fv1\u002Favatar\u002Fupdate",{"id":672,"title":673,"method":240,"path":674},"delete-avatar","Remove avatar","\u002Fapi\u002Fv1.1\u002Faccounts\u002Favatar",{"id":676,"title":677,"method":52,"path":678},"get-timeline-settings","Get timeline settings","\u002Fapi\u002Fv2.1\u002Faccount\u002Ftimeline\u002Fsettings",{"id":680,"title":681,"method":20,"path":678},"update-timeline-settings","Update timeline settings",{"id":683,"title":684,"method":20,"path":685},"change-password","Change password","\u002Fapi\u002Fv1.1\u002Faccounts\u002Fchange-password",{"id":687,"title":688,"method":52,"path":689},"get-two-factor","Get two-factor status","\u002Fapi\u002Fv1.1\u002Faccounts\u002Ftwo-factor",{"id":691,"title":692,"method":52,"path":693},"get-login-activity","Get login activity","\u002Fapi\u002Fv1.1\u002Faccounts\u002Flogin-activity",{"id":695,"title":696,"method":52,"path":697},"list-emails-from-pixelfed","List security emails","\u002Fapi\u002Fv1.1\u002Faccounts\u002Femails-from-pixelfed",{"id":699,"title":700,"method":52,"path":701},"list-authorized-apps","List authorized apps","\u002Fapi\u002Fv1.1\u002Faccounts\u002Fapps-and-applications",{"id":703,"title":704,"method":20,"path":705},"revoke-authorized-app","Revoke an app","\u002Fapi\u002Fv1.1\u002Faccounts\u002Fapps-and-applications\u002F{id}\u002Frevoke",{"id":707,"title":708,"method":52,"path":709},"lookup-username","Look up an account by username","\u002Fapi\u002Fv1.1\u002Faccounts\u002Fusername\u002F{username}",{"id":711,"title":712,"method":52,"path":713},"get-account-posts","Get recent posts by account","\u002Fapi\u002Fv1.1\u002Faccounts\u002F{id}\u002Fposts",{"id":715,"title":716,"method":52,"path":717},"get-mutual-accounts","Get mutual accounts","\u002Fapi\u002Fv1.1\u002Faccounts\u002Fmutuals\u002F{id}",{"id":719,"title":720,"method":20,"path":721},"delete-account-permanently","Delete account permanently","\u002Fapi\u002Fv2.1\u002Faccount\u002Fremove\u002Fpermanent",{"title":723,"to":724,"icon":725,"children":726},"Archive","\u002Fapi\u002Farchive","archive-box",[727,731,735],{"id":728,"title":729,"method":52,"path":730},"list-archived-posts","List archived posts","\u002Fapi\u002Fv1.1\u002Farchive\u002Flist",{"id":732,"title":733,"method":20,"path":734},"archive-post","Archive a post","\u002Fapi\u002Fv1.1\u002Farchive\u002Fadd\u002F{id}",{"id":736,"title":737,"method":20,"path":738},"unarchive-post","Unarchive a post","\u002Fapi\u002Fv1.1\u002Farchive\u002Fremove\u002F{id}",{"title":740,"to":741,"icon":742,"children":743},"Compose & places","\u002Fapi\u002Fcompose","map-pin",[744,748,752],{"id":745,"title":746,"method":52,"path":747},"get-compose-settings","Get compose settings","\u002Fapi\u002Fv1.1\u002Fcompose\u002Fsettings",{"id":749,"title":750,"method":52,"path":751},"search-locations","Search locations","\u002Fapi\u002Fv1.1\u002Fcompose\u002Fsearch\u002Flocation",{"id":753,"title":754,"method":52,"path":755},"get-place-posts","Get posts for a place","\u002Fapi\u002Fv1.1\u002Fplaces\u002Fposts\u002F{id}\u002F{slug}",{"title":757,"to":758,"icon":759,"children":760},"Push notifications","\u002Fapi\u002Fpush","bell-alert",[761,765,769,773],{"id":762,"title":763,"method":52,"path":764},"get-push-state","Get push state","\u002Fapi\u002Fv1.1\u002Fpush\u002Fstate",{"id":766,"title":767,"method":20,"path":768},"compare-push-token","Compare push token","\u002Fapi\u002Fv1.1\u002Fpush\u002Fcompare",{"id":770,"title":771,"method":20,"path":772},"update-push","Update push settings","\u002Fapi\u002Fv1.1\u002Fpush\u002Fupdate",{"id":774,"title":775,"method":20,"path":776},"disable-push","Disable push","\u002Fapi\u002Fv1.1\u002Fpush\u002Fdisable",{"title":778,"to":779,"icon":780,"children":781},"Registration","\u002Fapi\u002Fregistration","user-plus",[782,786,790,794,798,802,806,810,814],{"id":783,"title":784,"method":20,"path":785},"verify-email-code","Check an email code","\u002Fapi\u002Fauth\u002Fapp-code-verify",{"id":787,"title":788,"method":20,"path":789},"complete-app-registration","Complete in-app sign up","\u002Fapi\u002Fauth\u002Fonboarding",{"id":791,"title":792,"method":52,"path":793},"app-registration-preflight","Check legacy app sign up","\u002Fapi\u002Fv1.1\u002Fauth\u002Fiarpfc",{"id":795,"title":796,"method":20,"path":797},"start-legacy-registration","Start legacy sign up","\u002Fapi\u002Fv1.1\u002Fauth\u002Fiar",{"id":799,"title":800,"method":52,"path":801},"legacy-registration-email-redirect","Legacy email redirect","\u002Fapi\u002Fv1.1\u002Fauth\u002Fiarer",{"id":803,"title":804,"method":20,"path":805},"confirm-legacy-registration","Confirm legacy sign up","\u002Fapi\u002Fv1.1\u002Fauth\u002Fiarc",{"id":807,"title":808,"method":20,"path":809},"check-invite","Check an invite","\u002Fapi\u002Fv1.1\u002Fauth\u002Finvite\u002Fadmin\u002Fverify",{"id":811,"title":812,"method":20,"path":813},"check-invite-username","Check a username for an invite","\u002Fapi\u002Fv1.1\u002Fauth\u002Finvite\u002Fadmin\u002Fuc",{"id":815,"title":816,"method":20,"path":817},"check-invite-email","Check an email for an invite","\u002Fapi\u002Fv1.1\u002Fauth\u002Finvite\u002Fadmin\u002Fec",{"guide":819,"group":820},null,{"id":821,"title":448,"description":822,"embedded":823,"endpoints":824,"extension":1033,"icon":450,"meta":1034,"order":1035,"section":827,"stem":1036,"__hash__":1037},"groups\u002Fapi\u002Fcollections.yml","Curated sets of posts that sit on a profile, like an album.",false,[825,869,893,908,940,975,1002,1020],{"id":453,"method":52,"path":455,"title":454,"description":826,"compat":827,"result":828,"params":829,"callout":841,"returns":843,"example":844,"responses":848},"Returns an account's collections, newest first, 9 per page. Everyone sees published `public` collections, followers also see `private` ones, and the owner sees everything including drafts and collections that were never published.","pixelfed","collections",{"path":830,"query":836},[831],{"name":832,"type":833,"required":834,"desc":835},"id","string",true,"The account ID.",[837],{"name":838,"type":839,"desc":840},"page","integer","Page number, starting at `1`.",{"text":842},"For a private (locked) account the list is only returned to its followers, the owner and admins. Everyone else gets a 404.","an array of Collection. Paginate with `page` until you get an empty array.",{"path":845,"query":846},"\u002Fapi\u002Fv1.1\u002Fcollections\u002Faccounts\u002F2",{"page":847},1,[849,865],{"status":850,"body":851},200,[852],{"id":853,"pid":854,"visibility":855,"title":856,"description":857,"thumb":858,"url":859,"updated_at":860,"published_at":861,"avatar":862,"username":863,"post_count":864},"691204417380331520","2","public","Harbour mornings","One winter of walks before work","https:\u002F\u002Fpixelfed.social\u002Fstorage\u002Fm\u002F_v2\u002F2\u002Fharbour_thumb.jpg","https:\u002F\u002Fpixelfed.social\u002Fc\u002F691204417380331520","2026-03-30T06:48:12.000000Z","2026-02-11T07:05:41.000000Z","https:\u002F\u002Fpixelfed.social\u002Fstorage\u002Favatars\u002F412\u002F760\u002Favatar.jpg","dansup",14,{"status":866,"body":867},404,{"error":868},"Record not found",{"id":457,"method":52,"path":459,"title":458,"description":870,"compat":827,"result":828,"params":871,"callout":874,"returns":876,"responses":877},"Returns every collection owned by the token's account, whatever its visibility, newest first, 9 per page. Each one includes an `items` preview with up to 11 of its posts.",{"query":872},[873],{"name":838,"type":839,"desc":840},{"text":875},"This is the easiest way to find the ID of a draft you started in the web interface, since drafts have no title yet.","an array of Collection, each with an `items` array of posts in the [Pixelfed entity](\u002Fapi\u002Fpixelfed-entities) shape.",[878],{"status":850,"body":879},[880],{"id":853,"pid":854,"visibility":855,"title":856,"description":857,"thumb":858,"url":859,"updated_at":860,"published_at":861,"avatar":862,"username":863,"post_count":864,"items":881},[882],{"id":883,"shortcode":884,"url":885,"content_text":886,"visibility":855,"pf_type":292,"media_attachments":887,"account":892},"728341901556629504","W4kQ2pLm","https:\u002F\u002Fpixelfed.social\u002Fp\u002Fdansup\u002F728341901556629504","Golden hour at the pier",[888],{"id":889,"type":890,"url":891},"728341067224219648","image","https:\u002F\u002Fpixelfed.social\u002Fstorage\u002Fm\u002F_v2\u002F2\u002Fpier.jpg",{"id":854,"username":863},{"id":461,"method":52,"path":463,"title":462,"description":894,"compat":827,"result":895,"params":896,"returns":900,"example":901,"responses":903},"Returns one collection's details. Published `public` collections are visible to anyone with a token; `private` ones only to the owner's followers; drafts and unpublished collections only to the owner (and admins).","collection",{"path":897},[898],{"name":832,"type":833,"required":834,"desc":899},"The collection ID.","a Collection. The posts are fetched separately with [List collection posts](\u002Fapi\u002Fcollections#list-collection-items).",{"path":902},"\u002Fapi\u002Fv1.1\u002Fcollections\u002Fview\u002F691204417380331520",[904,906],{"status":850,"body":905},{"id":853,"pid":854,"visibility":855,"title":856,"description":857,"thumb":858,"url":859,"updated_at":860,"published_at":861,"avatar":862,"username":863,"post_count":864},{"status":866,"body":907},{"error":868},{"id":465,"method":52,"path":467,"title":466,"description":909,"compat":827,"result":910,"params":911,"callout":917,"returns":919,"example":920,"responses":923},"Returns the posts in a collection in their saved order, with the same visibility rules as [Get a collection](\u002Fapi\u002Fcollections#get-collection). Posts that were deleted, made private or have no media are skipped, so a page can come back shorter than expected.","posts",{"path":912,"query":914},[913],{"name":832,"type":833,"required":834,"desc":899},[915],{"name":838,"type":839,"desc":916},"Page number, starting at `1`. Defaults to `1`.",{"text":918},"Pages are about 10 posts. The ranges are inclusive at both ends, so a page can hold 11 posts and the last post of one page is repeated as the first of the next. De-duplicate by `id` when you append pages.","an array of Status in the [Pixelfed entity](\u002Fapi\u002Fpixelfed-entities) shape (not the Mastodon one).",{"path":921,"query":922},"\u002Fapi\u002Fv1.1\u002Fcollections\u002Fitems\u002F691204417380331520",{"page":847},[924,938],{"status":850,"body":925},[926],{"_v":847,"id":883,"shortcode":884,"uri":885,"url":885,"content":886,"content_text":886,"created_at":927,"favourites_count":928,"reblogs_count":929,"reply_count":930,"sensitive":823,"visibility":855,"pf_type":292,"local":834,"media_attachments":931,"account":937},"2026-09-14T17:42:10.000Z",31,2,4,[932],{"id":889,"type":890,"url":891,"preview_url":933,"description":934,"mime":935,"blurhash":936},"https:\u002F\u002Fpixelfed.social\u002Fstorage\u002Fm\u002F_v2\u002F2\u002Fpier_thumb.jpg","Wooden pier at sunset, two people fishing at the far end","image\u002Fjpeg","UJF}Qo~W9aIV4.xuRjWB00WB-pof",{"id":854,"username":863,"acct":863,"display_name":863,"avatar":862,"local":834},{"status":866,"body":939},{"error":868},{"id":469,"method":20,"path":471,"title":470,"description":941,"compat":827,"result":895,"params":942,"callout":956,"returns":959,"example":960,"responses":963},"Sets a collection's title, description and visibility. HTML tags are stripped. All three fields are written on every call, so an omitted `title` or `description` is cleared.",{"path":943,"body":946},[944],{"name":832,"type":833,"required":834,"desc":945},"A collection you own.",[947,950,953],{"name":948,"type":833,"desc":949},"title","Up to 50 characters.",{"name":951,"type":833,"desc":952},"description","Up to 500 characters.",{"name":954,"type":833,"required":834,"desc":955},"visibility","One of `public`, `private` (followers only) or `draft`.",{"icon":957,"text":958},"information-circle","There is no token-authenticated route that creates or publishes a collection. A new collection is made in the web interface: visiting `\u002Fi\u002Fcollections\u002Fcreate` while signed in creates an empty draft (or reuses your existing unpublished one), and the web editor's publish step sets `published_at` once the collection has at least one post. This endpoint never sets `published_at`, so a collection that was never published stays out of other people's [lists](\u002Fapi\u002Fcollections#list-collections) even when its `visibility` is `public`.","the updated Collection.",{"path":961,"body":962},"\u002Fapi\u002Fv1.1\u002Fcollections\u002Fupdate\u002F691204417380331520",{"title":856,"description":857,"visibility":855},[964,967,973],{"status":850,"body":965},{"id":853,"pid":854,"visibility":855,"title":856,"description":857,"thumb":858,"url":859,"updated_at":966,"published_at":861,"avatar":862,"username":863,"post_count":864},"2026-10-17T09:14:03.000000Z",{"status":968,"body":969},422,{"message":970,"errors":971},"The visibility field is required.",{"visibility":972},[970],{"status":866,"body":974},{"error":868},{"id":473,"method":20,"path":475,"title":474,"description":976,"compat":827,"result":977,"params":978,"callout":985,"returns":987,"example":988,"responses":990},"Appends one of your own posts to the end of a collection you own. Only `public` or `unlisted` photo, album and video posts can be added. Adding a post that is already there does nothing and still succeeds.","post",{"body":979},[980,982],{"name":981,"type":833,"required":834,"desc":945},"collection_id",{"name":983,"type":833,"required":834,"desc":984},"post_id","One of your own posts.",{"text":986},"A collection holds at most 100 posts by default. The instance's real limit is `limits.collections.max_collection_length` in `GET \u002Fapi\u002Fv2.1\u002Fconfig`.","the added post as a Status in the [Pixelfed entity](\u002Fapi\u002Fpixelfed-entities) shape.",{"body":989},{"collection_id":853,"post_id":883},[991,996,1000],{"status":850,"body":992},{"_v":847,"id":883,"shortcode":884,"url":885,"content_text":886,"visibility":855,"pf_type":292,"media_attachments":993,"account":995},[994],{"id":889,"type":890,"url":891},{"id":854,"username":863},{"status":997,"body":998},400,{"error":999},"You can only add 100 posts per collection",{"status":866,"body":1001},{"error":868},{"id":477,"method":20,"path":479,"title":478,"description":1003,"compat":827,"result":1004,"params":1005,"returns":1010,"example":1011,"responses":1013},"Takes a post out of a collection you own and renumbers the remaining posts. The post itself is not deleted. You cannot remove the last post; delete the collection instead.","result",{"body":1006},[1007,1008],{"name":981,"type":833,"required":834,"desc":945},{"name":983,"type":833,"required":834,"desc":1009},"The post to remove.","the number `200`.",{"body":1012},{"collection_id":853,"post_id":883},[1014,1015,1018],{"status":850,"body":850},{"status":997,"body":1016},{"error":1017},"You cannot delete the only post of a collection!",{"status":866,"body":1019},{"error":868},{"id":481,"method":240,"path":483,"title":482,"description":1021,"compat":827,"result":1004,"params":1022,"callout":1025,"returns":1010,"example":1027,"responses":1029},"Deletes a collection you own. The posts in it are kept; only the collection and its list of items are removed.",{"path":1023},[1024],{"name":832,"type":833,"required":834,"desc":945},{"text":1026},"Send `Accept: application\u002Fjson`. Without it the server answers with a redirect to `\u002F` instead of a JSON body.",{"path":1028},"\u002Fapi\u002Fv1.1\u002Fcollections\u002Fdelete\u002F691204417380331520",[1030,1031],{"status":850,"body":850},{"status":866,"body":1032},{"error":868},"yml",{},0,"api\u002Fcollections","bhCCXZX-zrds3qqPAgtjdoNbPvAIRTgB0FMqjxiPe7o",1792230652876]