[{"data":1,"prerenderedAt":1114},["ShallowReactive",2],{"docs-nav":3,"docs-page-stories":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":577,"description":822,"embedded":823,"endpoints":824,"extension":1109,"icon":579,"meta":1110,"order":1111,"section":827,"stem":1112,"__hash__":1113},"groups\u002Fapi\u002Fstories.yml","Ephemeral photo and video posts that disappear from the carousel after 24 hours.",false,[825,877,896,943,969,995,1026,1046,1074,1095],{"id":582,"method":52,"path":584,"title":583,"description":826,"compat":827,"result":828,"callout":829,"returns":831,"responses":832},"Returns one entry per author with active stories, built from the story index in Redis. Your own stories come first, then authors you haven't fully watched, then the rest, newest first. This replaces the v1.1 carousel: there is no separate `self` object, `duration` is in milliseconds (never below 10000), each story carries its `overlays`, and your own stories include a `view_count`.","pixelfed","carousel",{"icon":47,"text":830},"Stories are off unless the admin enables them (`STORIES_ENABLED`). Every stories endpoint returns 404 when they are off, so check `features.stories` in `\u002Fapi\u002Fv2.1\u002Fconfig` before showing any stories UI.","an object with a `nodes` array. Each node is an author with their `stories`, ordered oldest first, and `hasViewed` is true once you have seen all of them.",[833,873],{"status":834,"body":835},200,{"nodes":836},[837,861],{"id":838,"username":839,"username_acct":839,"profile_id":840,"avatar":841,"is_author":842,"stories":843,"url":860,"hasViewed":842},"self:2","dansup","2","https:\u002F\u002Fpixelfed.social\u002Fstorage\u002Favatars\u002F2\u002Favatar.jpg",true,[844],{"id":845,"type":292,"url":846,"overlays":847,"duration":857,"viewed":842,"created_at":858,"view_count":859},"731056220419686400","https:\u002F\u002Fpixelfed.social\u002Fstorage\u002F_esm.t3\u002FKq9y\u002FxN4bRe2\u002F17aQ3kTz\u002FAb_t7Lw2nR.jpg",[848],{"type":849,"content":850,"color":851,"fontSize":852,"x":853,"y":854,"rotation":855,"scale":856},"text","Low tide again","#FFFFFF",42,540,1500,0,1,10000,"2026-10-17T07:12:44+00:00",23,"https:\u002F\u002Fpixelfed.social\u002Fstories\u002Fdansup",{"id":862,"username":863,"username_acct":863,"profile_id":864,"avatar":865,"is_author":823,"stories":866,"url":872,"hasViewed":823},"pfs:412760184563377","jonas","412760184563377","https:\u002F\u002Fpixelfed.social\u002Fstorage\u002Favatars\u002F412760184563377\u002Favatar.jpg",[867],{"id":868,"type":292,"url":869,"overlays":870,"duration":857,"viewed":823,"created_at":871},"731061790234124288","https:\u002F\u002Fpixelfed.social\u002Fstorage\u002F_esm.t3\u002FKq9y\u002FpL0dWe8\u002F17Hc8mYr\u002FQe_s91Kd2.jpg",[],"2026-10-17T08:34:02+00:00","https:\u002F\u002Fpixelfed.social\u002Fstories\u002Fjonas",{"status":874,"body":875},404,{"error":876},"Record not found",{"id":586,"method":52,"path":588,"title":587,"description":878,"compat":827,"result":828,"returns":879,"responses":880},"The older carousel, built with a database query and cached for 5 minutes per viewer. Your own active stories are returned separately under `self` (an empty array when you have none), and `duration` is in seconds. New clients should use [Get the stories carousel](\u002Fapi\u002Fstories#get-carousel).","an object with `self` (your own stories, or `[]`) and `nodes`, one entry per followed author, unseen authors first.",[881,894],{"status":834,"body":882},{"self":883,"nodes":888},{"user":884,"nodes":885},{"id":840,"username":839,"avatar":841,"local":842,"is_author":842},[886],{"id":845,"type":292,"src":846,"duration":887,"seen":842,"created_at":858},5,[889],{"id":862,"user":890,"nodes":891,"url":872,"seen":823},{"id":864,"username":863,"username_acct":863,"avatar":865,"local":842,"is_author":823},[892],{"id":868,"pid":864,"type":292,"src":869,"duration":893,"seen":823,"created_at":871},3,{"status":874,"body":895},{"error":876},{"id":590,"method":20,"path":592,"title":591,"description":897,"compat":827,"result":898,"params":899,"callout":919,"returns":921,"example":922,"responses":929},"Uploads a photo and publishes it as a story in one request, with up to 4 overlays (text, mentions, links, hashtags) drawn on top by the client. The story goes live immediately and expires 24 hours later. Unlike the v1.1 flow there is no separate upload step, the display time is fixed at 7 seconds, and replies and reactions are turned off, so [Reply to a story](\u002Fapi\u002Fstories#reply-to-story) is rejected for these stories.","story",{"body":900},[901,905,909,913,916],{"name":902,"type":903,"required":842,"desc":904},"image","file","A JPEG or PNG of exactly 1080 by 1920 pixels, at least 10 KB and no larger than the server's `max_photo_size` (in KB). Video is not accepted here.",{"name":906,"type":907,"desc":908},"overlays[]","array of objects","Up to 4 overlays. Each one takes `type` (`text`, `mention`, `url` or `hashtag`), `content` (1 to 250 characters), `x`, `y`, `absoluteX`, `absoluteY`, `rotation` (-360 to 360), `scale` and `absoluteScale` (0.1 to 5), `fontSize` (10 to 180) and `color` (hex).",{"name":910,"type":911,"desc":912},"overlays[][content]","string","Checked per type: a `hashtag` must look like `#tag` (up to 29 characters after `#`), a `url` must be `https:\u002F\u002F`, and a `mention` must be a username that follows you (find one with [Autocomplete mentions](\u002Fapi\u002Fstories#autocomplete-mentions)). The leading `@` is stripped.",{"name":914,"type":911,"desc":915},"overlays[][backgroundColor]","One of `transparent`, `#FFFFFF` or `#000000`. Validated, but currently not saved.",{"name":917,"type":911,"desc":918},"overlays[][fontFamily]","One of `default`, `serif`, `mono`, `rounded` or `bold`. Validated, but currently not saved.",{"icon":579,"text":920},"Each account can have 20 active stories at a time. Past that the server answers 418 until older stories expire.","`{ code, msg }` on success. The story then appears in the carousel.",{"files":923,"fields":925},{"image":924},"low-tide.jpg",{"overlays[0][type]":849,"overlays[0][content]":850,"overlays[0][color]":851,"overlays[0][fontSize]":926,"overlays[0][x]":927,"overlays[0][y]":928},"42","540","1500",[930,933,937],{"status":834,"body":931},{"code":834,"msg":932},"Successfully added",{"status":934,"body":935},418,{"code":934,"error":936},"You’ve reached your daily limit of 20 Stories.",{"status":938,"body":939},422,{"message":940,"errors":941},"The image field has invalid image dimensions.",{"image":942},[940],{"id":594,"method":52,"path":596,"title":595,"description":944,"compat":827,"result":945,"params":946,"returns":951,"example":952,"responses":955},"Suggests accounts for a `mention` overlay. Only accounts that follow you are returned, because only they can be mentioned in a story. Matches the start of the username and returns at most 10, sorted by username.","accounts",{"query":947},[948],{"name":949,"type":911,"required":842,"desc":950},"q","The username prefix, up to 120 characters. A leading `@` is ignored.","an array of up to 10 accounts in the [Pixelfed shape](\u002Fapi\u002Fpixelfed-entities).",{"query":953},{"q":954},"@jo",[956,964],{"status":834,"body":957},[958],{"id":864,"username":863,"acct":863,"display_name":959,"locked":823,"followers_count":960,"following_count":961,"statuses_count":962,"url":963,"avatar":865,"local":842,"has_story":842},"Jonas Berg",318,204,96,"https:\u002F\u002Fpixelfed.social\u002Fjonas",{"status":938,"body":965},{"message":966,"errors":967},"The q field is required.",{"q":968},[966],{"id":598,"method":20,"path":600,"title":599,"description":970,"compat":827,"result":971,"params":972,"returns":980,"example":981,"responses":986},"First step of the v1.1 flow. Uploads a photo or MP4 video and creates an inactive story, which nobody can see until you call [Publish a story (v1.1)](\u002Fapi\u002Fstories#publish-story-v1). The 24 hour expiry starts at upload time, not at publish time.","upload",{"body":973},[974,976],{"name":903,"type":903,"required":842,"desc":975},"A JPEG, PNG or MP4, no larger than the server's `max_photo_size` (in KB).",{"name":977,"type":978,"desc":979},"duration","integer","How long to show it, 0 to 30 seconds. Defaults to 3.","`media_id` (the story ID to publish), `media_url` and `media_type` (`photo` or `video`).",{"files":982,"fields":984},{"file":983},"harbour.mp4",{"duration":985},"8",[987,992],{"status":834,"body":988},{"code":834,"msg":932,"media_id":989,"media_url":990,"media_type":991},"731070114392444928","https:\u002F\u002Fpixelfed.social\u002Fstorage\u002F_esm.t3\u002FKq9y\u002FxN4bRe2\u002F17Zp2cVb\u002FLm_c8Qe1.mp4?v=1792226184","video",{"status":934,"body":993},{"error":994},"You have reached your limit for new Stories today.",{"id":602,"method":20,"path":604,"title":603,"description":996,"compat":827,"result":898,"params":997,"returns":1011,"example":1012,"responses":1015},"Second step of the v1.1 flow. Makes an uploaded story visible, sets whether followers can reply or react, and pushes it to followers on other servers. Unlike the v1.2 endpoint it accepts video, has no overlays and lets you choose the duration and reply settings.",{"body":998},[999,1002,1004,1008],{"name":1000,"type":911,"required":842,"desc":1001},"media_id","The `media_id` from [Upload story media (v1.1)](\u002Fapi\u002Fstories#upload-story). Must be your own.",{"name":977,"type":978,"required":842,"desc":1003},"How long to show it, 0 to 30 seconds.",{"name":1005,"type":1006,"required":842,"desc":1007},"can_reply","boolean","Whether followers can reply with [Reply to a story](\u002Fapi\u002Fstories#reply-to-story).",{"name":1009,"type":1006,"required":842,"desc":1010},"can_react","Whether followers can react.","`{ code, msg }`.",{"body":1013},{"media_id":989,"duration":1014,"can_reply":842,"can_react":842},8,[1016,1019,1021],{"status":834,"body":1017},{"code":834,"msg":1018},"Successfully published",{"status":874,"body":1020},{"error":876},{"status":938,"body":1022},{"message":1023,"errors":1024},"The can reply field is required.",{"can_reply":1025},[1023],{"id":606,"method":20,"path":608,"title":607,"description":1027,"compat":827,"result":1028,"params":1029,"returns":1034,"example":1035,"responses":1037},"Records that you viewed a story, so it shows as viewed in the carousel and you appear in the author's viewer list. You must follow the author. Marking your own story returns an empty array and records nothing. For stories from other servers a View activity is sent to the author's server.","result",{"body":1030},[1031],{"name":1032,"type":911,"required":842,"desc":1033},"id","The story ID. The story must still be active.","`{ code: 200 }`, or `[]` for your own story.",{"body":1036},{"id":868},[1038,1040,1044],{"status":834,"body":1039},{"code":834},{"status":1041,"body":1042},403,{"error":1043},"Invalid permission",{"status":874,"body":1045},{"error":876},{"id":610,"method":52,"path":612,"title":611,"description":1047,"compat":827,"result":1048,"params":1049,"returns":1057,"example":1058,"responses":1060},"Lists who has viewed one of your active stories, most recent first, 10 per page.","viewers",{"query":1050},[1051,1054],{"name":1052,"type":911,"required":842,"desc":1053},"sid","The story ID, up to 50 characters. Must be your own active story.",{"name":1055,"type":911,"desc":1056},"cursor","The `meta.next_cursor` value from the previous page.","a Laravel cursor page: `data` holds accounts in the [Pixelfed shape](\u002Fapi\u002Fpixelfed-entities) with an added `viewed_at`, and `meta.next_cursor` (or `links.next`) fetches the next page. This is not Link header [Pagination](\u002Fapi\u002Fpagination).",{"query":1059},{"sid":845},[1061,1072],{"status":834,"body":1062},{"data":1063,"links":1066,"meta":1068},[1064],{"id":864,"username":863,"acct":863,"display_name":959,"avatar":865,"local":842,"viewed_at":1065},"2026-10-17T08:41:19+00:00",{"first":819,"last":819,"prev":819,"next":1067},"https:\u002F\u002Fpixelfed.social\u002Fapi\u002Fv1.2\u002Fstories\u002Fviewers?sid=731056220419686400&cursor=eyJpZCI6NzMxMDU5MDAyLCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9",{"path":1069,"per_page":1070,"next_cursor":1071,"prev_cursor":819},"https:\u002F\u002Fpixelfed.social\u002Fapi\u002Fv1.2\u002Fstories\u002Fviewers",10,"eyJpZCI6NzMxMDU5MDAyLCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9",{"status":874,"body":1073},{"error":876},{"id":614,"method":20,"path":616,"title":615,"description":1075,"compat":827,"result":1028,"params":1076,"returns":1011,"example":1083,"responses":1086},"Sends a private reply to the story's author. It lands in your direct message conversation with them, and is delivered to their server if they are remote. You must follow the author, must not be blocked by them, and the story must allow replies. Stories made with [Publish a story](\u002Fapi\u002Fstories#publish-story) never allow replies.",{"body":1077},[1078,1080],{"name":1052,"type":911,"required":842,"desc":1079},"The story ID. The story must be active and not expired.",{"name":1081,"type":911,"required":842,"desc":1082},"caption","The reply text.",{"body":1084},{"sid":868,"caption":1085},"Is that the old ferry dock?",[1087,1090,1092],{"status":834,"body":1088},{"code":834,"msg":1089},"Sent!",{"status":1041,"body":1091},{"error":1043},{"status":938,"body":1093},{"error":1094},"",{"id":618,"method":20,"path":620,"title":619,"description":1096,"compat":827,"result":1028,"params":1097,"returns":1011,"example":1101,"responses":1103},"Expires one of your stories right away. It is removed from the carousel and a delete is sent to followers on other servers.",{"path":1098},[1099],{"name":1032,"type":911,"required":842,"desc":1100},"The story ID. Must be your own.",{"path":1102},"\u002Fapi\u002Fv1.1\u002Fstories\u002Fself-expire\u002F731056220419686400",[1104,1107],{"status":834,"body":1105},{"code":834,"msg":1106},"Successfully deleted",{"status":874,"body":1108},{"error":876},"yml",{},2,"api\u002Fstories","LyhX8N9n1UBabvxKxmSPTYq9pbyofRz7-MvFMFIIKnw",1792230652877]