[{"data":1,"prerenderedAt":1086},["ShallowReactive",2],{"docs-nav":3,"docs-page-registration":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":778,"description":822,"embedded":823,"endpoints":824,"extension":1081,"icon":780,"meta":1082,"order":1083,"section":827,"stem":1084,"__hash__":1085},"groups\u002Fapi\u002Fregistration.yml","Create new accounts from inside an app, by email code, by the older email link flow, or with an admin invite.",false,[825,863,933,942,972,999,1022,1045,1062],{"id":783,"method":20,"path":785,"title":784,"description":826,"compat":827,"auth":823,"result":828,"params":829,"callout":839,"returns":842,"example":843,"responses":847},"Checks the 6 digit code that was emailed during in-app sign up, without creating anything. Use it to confirm the code before you ask for a username and password. A wrong or expired code returns HTTP 200 with `{\"status\": \"error\"}`, and each wrong guess counts toward a limit of 10 per code.","pixelfed","check",{"body":830},[831,836],{"name":832,"type":833,"required":834,"desc":835},"email","string",true,"The address the code was sent to. Must have a pending code and must not belong to an existing account.",{"name":837,"type":833,"required":834,"desc":838},"verify_code","Exactly 6 digits.",{"icon":840,"text":841},"information-circle","How in-app sign up works. 1) Check `mobile_registration` in [`GET \u002Fapi\u002Fv1\u002Finstance`](\u002Fapi\u002Finstance) or `signup.mobile_registration` in `GET \u002Fapi\u002Fv2.1\u002Fconfig`. It is `true` only when both `OPEN_REGISTRATION` and `APP_REGISTER` (`auth.in_app_registration`) are on. 2) Open `https:\u002F\u002Fpixelfed.social\u002Fi\u002Fapp-email-verify` in a browser, optionally with `?redirect_uri=yourapp:\u002F\u002Fverify`. The person enters their email (and a captcha if the server uses one), the server emails a 6 digit code valid for 1 hour, then redirects to your `redirect_uri` with `status=success&email=...&expires_in=3600`, or `status=error&message=...`. Without `redirect_uri` it goes to `pixelfed:\u002F\u002FverifyEmail`, and the scheme must be listed in `IN_APP_REGISTRATION_REDIRECT_SCHEMES` (default `pixelfed`). 3) Call this endpoint with the code. 4) Call [Complete in-app sign up](\u002Fapi\u002Fregistration#complete-app-registration) with the code, username and password. New codes are requested at `\u002Fi\u002Fapp-email-resend` (up to 5 resends).","`{\"status\": \"success\"}` or `{\"status\": \"error\"}`.",{"body":844},{"email":845,"verify_code":846},"dansup@example.com","048213",[848,852,858],{"status":849,"body":850},200,{"status":851},"success",{"status":853,"body":854},422,{"message":855,"errors":856},"The selected email is invalid.",{"email":857},[855],{"status":859,"body":860},429,{"status":861,"message":862},"error","Too many verification attempts. Please request a new code.",{"id":787,"method":20,"path":789,"title":788,"description":864,"compat":827,"auth":823,"result":865,"params":866,"callout":890,"returns":892,"example":893,"responses":900},"Creates the account (with the email already verified) once the emailed code checks out, and signs it in. Pass your app's `client_id` and `client_secret` from [Register an app](\u002Fapi\u002Foauth#register-app) to get a normal OAuth token pair that works with the `refresh_token` grant. Without them you get the legacy response: a personal access token with `read write follow push`, the server's personal access `client_id` and `client_secret`, and a `refresh_token` that cannot be used to refresh.","session",{"body":867},[868,870,872,875,878,881,884,887],{"name":832,"type":833,"required":834,"desc":869},"The verified address. Must have a pending code and must not belong to an existing account.",{"name":837,"type":833,"required":834,"desc":871},"The 6 digit code from the email.",{"name":873,"type":833,"required":834,"desc":874},"username","2 to 30 characters, unique. Letters and numbers, plus at most one `-`, `.` or `_`, and it must start and end with a letter or number. Reserved names are rejected.",{"name":876,"type":833,"desc":877},"name","Display name, up to `max_name_length` characters. Optional.",{"name":879,"type":833,"required":834,"desc":880},"password","At least `MIN_PASSWORD_LENGTH` characters (default 8).",{"name":882,"type":833,"desc":883},"client_id","Your app's client ID, up to 80 characters. Required with `client_secret`.",{"name":885,"type":833,"desc":886},"client_secret","Your app's client secret. Required with `client_id`. The client must be confidential.",{"name":888,"type":833,"desc":889},"scope","Space or `+` separated scopes for the token, only used with `client_id`. Defaults to `read write follow push`. Unknown scopes and `*` are rejected.",{"icon":34,"text":891},"Some failures come back as HTTP 200 with `status: error`, so always check `status`. `code: invalid_code` means the code is wrong or older than 1 hour. `code: account_created_token_failed` means the account exists but no token could be issued, so send the person to normal sign in. Client and scope problems are checked before the account is created.","a session object with the tokens, the server `domain` and the new Account in the [Pixelfed shape](\u002Fapi\u002Fpixelfed-entities).",{"body":894},{"email":845,"verify_code":846,"username":895,"name":895,"password":896,"client_id":897,"client_secret":898,"scope":899},"dansup","harbour-fog-1987","1842","q8V3zN1rKcT0fYd6LwP2sHbJ7mXeA9uR4oGiE5nC","read write follow push",[901,920,925,930],{"status":849,"body":902},{"status":851,"domain":903,"token_type":904,"access_token":905,"refresh_token":906,"expires_in":907,"scope":908,"client_id":897,"user":913,"account":915},"pixelfed.social","Bearer","eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxODQyIn0.kM2p","def50200a1c4e9b7f0d3a6c2e8b5f1d4a7c0e3b6",30758400,[909,910,911,912],"read","write","follow","push",{"pid":914,"username":895},"2",{"id":914,"username":895,"acct":895,"display_name":895,"locked":823,"followers_count":916,"following_count":916,"statuses_count":916,"url":917,"avatar":918,"local":834,"created_at":919},0,"https:\u002F\u002Fpixelfed.social\u002Fdansup","https:\u002F\u002Fpixelfed.social\u002Fstorage\u002Favatars\u002Fdefault.jpg","2026-10-17T08:02:19.000000Z",{"status":921,"body":922},401,{"status":861,"code":923,"message":924},"invalid_client","Invalid client credentials.",{"status":853,"body":926},{"message":927,"errors":928},"The username has already been taken.",{"username":929},[927],{"status":859,"body":931},{"status":861,"code":932,"message":862},"locked",{"id":791,"method":52,"path":793,"title":792,"description":934,"compat":827,"auth":823,"result":935,"callout":936,"returns":938,"responses":939},"Tells the app whether the older email link sign up flow is available. `open` mirrors `OPEN_REGISTRATION` and `iara` mirrors the admin setting `PF_ALLOW_APP_REGISTRATION` (`pixelfed.allow_app_registration`). Both must be `true` for the legacy calls below to work. This flag is separate from `APP_REGISTER`, which gates the email code flow above.","preflight",{"icon":840,"text":937},"The legacy flow, in order: 1) call this preflight. 2) [Start legacy sign up](\u002Fapi\u002Fregistration#start-legacy-registration) with email, username and password. The account is created right away, unverified, and the server emails a confirmation link. 3) The link opens [the email redirect](\u002Fapi\u002Fregistration#legacy-registration-email-redirect), which hands the tokens to the app through a `pixelfed:\u002F\u002Fconfirm-account\u002F...` deep link. 4) [Confirm legacy sign up](\u002Fapi\u002Fregistration#confirm-legacy-registration) with those tokens to get an access token. Steps 2 and 4 need the `X-PIXELFED-APP` request header.","an object with `open` and `iara` booleans.",[940],{"status":849,"body":941},{"open":834,"iara":834},{"id":795,"method":20,"path":797,"title":796,"description":943,"compat":827,"auth":823,"result":944,"params":945,"returns":953,"example":954,"responses":956},"Creates an unverified account and emails a confirmation link to the address. The request must carry an `X-PIXELFED-APP` header (any value) or it gets a 403, and it must not be authenticated. Attempts are limited per IP to `PF_IAR_RL_ATTEMPTS` (default 3) every `PF_IAR_RL_DECAY` seconds (default 1800), and every attempt counts, including ones that fail validation.","res",{"body":946},[947,949,951],{"name":832,"type":833,"required":834,"desc":948},"A valid address up to 255 characters, not already in use and not on the server's banned email list.",{"name":873,"type":833,"required":834,"desc":950},"2 to 30 characters, unique. Letters and numbers, plus at most one `-`, `.` or `_`, starting and ending with a letter or number.",{"name":879,"type":833,"required":834,"desc":952},"At least 8 characters. This flow does not use `MIN_PASSWORD_LENGTH`.","`{\"success\": true}`. The username and email are taken from this point on, even before the email is confirmed.",{"body":955},{"email":845,"username":895,"password":896},[957,959,963,967],{"status":849,"body":958},{"success":834},{"status":960,"body":961},400,{"error":962},"Too many requests",{"status":964,"body":965},404,{"error":966},"",{"status":853,"body":968},{"message":969,"errors":970},"The email has already been taken.",{"email":971},[969],{"id":799,"method":52,"path":801,"title":800,"description":973,"compat":827,"auth":823,"result":944,"params":974,"returns":985,"example":986,"responses":991},"The page the confirmation email links to. You do not call it yourself. It redirects the browser to `pixelfed:\u002F\u002Fconfirm-account\u002F{ut}?ut=...&rt=...&domain=pixelfed.social&ea=...`, so the Pixelfed app can pick up the tokens. `ea` is the email address in base64. The scheme is always `pixelfed`, so third party apps cannot receive this redirect.",{"query":975},[976,979,982],{"name":977,"type":833,"required":834,"desc":978},"ut","The user token from the email link.",{"name":980,"type":833,"required":834,"desc":981},"rt","The random token from the email link.",{"name":983,"type":833,"required":834,"desc":984},"ea","The email address, base64 encoded.","a 302 redirect to the `pixelfed:\u002F\u002Fconfirm-account\u002F` deep link.",{"query":987},{"ut":988,"rt":989,"ea":990},"7Hq2LmZ9xVb4NcR1sTe8KpW3yUa6JdF0gOiE5nXz","Rk4vT9pLq2Wm7Zc1Xs8Nb3Ye6Ja0Hd5Gf9Uo2Ii7Ee4Rt1Lq8Wm3Zc6Xs0Nb5Ye9Ja2Hd7Gf4Uo1Ii6Ee3R","bWFyYUBleGFtcGxlLmNvbQ==",[992,994],{"status":993},302,{"status":853,"body":995},{"message":996,"errors":997},"The rt field is required.",{"rt":998},[996],{"id":803,"method":20,"path":805,"title":804,"description":1000,"compat":827,"auth":823,"result":865,"params":1001,"returns":1011,"example":1012,"responses":1014},"Verifies the email using the tokens from the deep link, marks the address as verified and returns a personal access token with `read write follow push`. Needs the `X-PIXELFED-APP` header and an unauthenticated request. Tokens older than 24 hours are rejected and deleted.",{"body":1002},[1003,1006,1009],{"name":1004,"type":833,"required":834,"desc":1005},"user_token","The `ut` value from the deep link.",{"name":1007,"type":833,"required":834,"desc":1008},"random_token","The `rt` value from the deep link.",{"name":832,"type":833,"required":834,"desc":1010},"The email address in plain text (decode `ea` from base64 first).","an object with `access_token`. There is no refresh token, so store the access token.",{"body":1013},{"user_token":988,"random_token":989,"email":845},[1015,1018],{"status":849,"body":1016},{"access_token":1017},"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxIn0.Zq7d",{"status":1019,"body":1020},403,{"error":1021},"Invalid tokens",{"id":807,"method":20,"path":809,"title":808,"description":1023,"compat":827,"auth":823,"result":1024,"params":1025,"returns":1030,"example":1031,"responses":1034},"Checks an admin invite code before showing the invite sign up form. Invites work even when open registration is off. Invite links look like `https:\u002F\u002Fpixelfed.social\u002Fauth\u002Finvite\u002Fa\u002F{code}`, and the whole invite feature returns 404 when `PF_ADMIN_INVITES_ENABLED` is off. Limited to 20 requests per 120 minutes per IP.","invite",{"body":1026},[1027],{"name":1028,"type":833,"required":834,"desc":1029},"token","The invite code from the invite link.","the invite's welcome `message` (or `null`), `max_uses` (or `null` for unlimited) and `sev`, which is `true` when accounts created with this invite skip email verification.",{"body":1032},{"token":1033},"Xb7kQ2mZ9pLc",[1035,1039,1042],{"status":849,"body":1036},{"message":1037,"max_uses":1038,"sev":834},"Welcome to the photo walk crew!",25,{"status":960,"body":1040},{"error":1041},"Invite has expired.",{"status":964,"body":1043},{"error":1044},"Record not found",{"id":811,"method":20,"path":813,"title":812,"description":1046,"compat":827,"auth":823,"result":828,"params":1047,"returns":1053,"example":1054,"responses":1056},"Checks whether a username is valid and free, for live feedback on the invite sign up form. The invite must still be valid. Limited to 20 requests per 120 minutes per IP.",{"body":1048},[1049,1051],{"name":1028,"type":833,"required":834,"desc":1050},"The invite code.",{"name":873,"type":833,"required":834,"desc":1052},"The username to check. Same rules as sign up: 2 to 30 characters, unique, at most one `-`, `.` or `_`.","an empty array `[]` when the username is available. A taken or invalid name returns 400 with the field errors keyed by `username` (not the usual 422 shape).",{"body":1055},{"token":1033,"username":895},[1057,1059],{"status":849,"body":1058},[],{"status":960,"body":1060},{"username":1061},[927],{"id":815,"method":20,"path":817,"title":816,"description":1063,"compat":827,"auth":823,"result":828,"params":1064,"returns":1069,"example":1070,"responses":1072},"Checks whether an email address is valid (strict RFC check with a DNS lookup), unused and not banned, for the invite sign up form. The invite must still be valid. Limited to 10 requests per 24 hours per IP, so check once on submit rather than on every keystroke.",{"body":1065},[1066,1067],{"name":1028,"type":833,"required":834,"desc":1050},{"name":832,"type":833,"required":834,"desc":1068},"The address to check, up to 255 characters.","an empty array `[]` when the address can be used, or 400 with the field errors keyed by `email`.",{"body":1071},{"token":1033,"email":845},[1073,1075,1078],{"status":849,"body":1074},[],{"status":960,"body":1076},{"email":1077},[969],{"status":859,"body":1079},{"error":1080},"Too Many Attempts.","yml",{},8,"api\u002Fregistration","mhWD7xnfnmYwHuFO_AqSVczujprIm7XMXgqcpYozlAE",1792230652881]