Something went wrong. Try again.
A lexicon-driven AppView for ATProto.
Something went wrong. Try again.
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788<!doctype html><html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-reference/xrpc-api" data-has-hydrated="false"><head><meta charset="UTF-8"><meta name="generator" content="Docusaurus v3.10.0"><title data-rh="true">XRPC API | HappyView</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://happyview.dev/img/og.png"><meta data-rh="true" name="twitter:image" content="https://happyview.dev/img/og.png"><meta data-rh="true" property="og:url" content="https://happyview.dev/reference/xrpc-api"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="XRPC API | HappyView"><meta data-rh="true" name="description" content="XRPC is the HTTP-based RPC protocol used by the atproto. HappyView dynamically registers XRPC endpoints based on your uploaded lexicons: query lexicons become GET /xrpc/ routes, procedure lexicons become POST /xrpc/{nsid} routes."><meta data-rh="true" property="og:description" content="XRPC is the HTTP-based RPC protocol used by the atproto. HappyView dynamically registers XRPC endpoints based on your uploaded lexicons: query lexicons become GET /xrpc/ routes, procedure lexicons become POST /xrpc/{nsid} routes."><link data-rh="true" rel="icon" href="/img/favicon.png"><link data-rh="true" rel="canonical" href="https://happyview.dev/reference/xrpc-api"><link data-rh="true" rel="alternate" href="https://happyview.dev/reference/xrpc-api" hreflang="en"><link data-rh="true" rel="alternate" href="https://happyview.dev/reference/xrpc-api" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"XRPC API","item":"https://happyview.dev/reference/xrpc-api"}]}</script><link rel="stylesheet" href="/assets/css/styles.18b9c377.css"><script src="/assets/js/runtime~main.413aac68.js" defer="defer"></script><script src="/assets/js/main.c991874c.js" defer="defer"></script></head><body><svg style="display: none;"><defs><symbol id="theme-svg-external-link" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol></defs></svg><script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||"light"),document.documentElement.setAttribute("data-theme-choice",t||"light")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><link rel="preload" as="image" href="/img/logo.light.png"><link rel="preload" as="image" href="/img/logo.dark.png"><div role="region" aria-label="Skip to main content"><a class="skipToContent_hn_G" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo.light.png" alt="HappyView" class="themedComponent_EfZ_ themedComponent--light_EnZ3"><img src="/img/logo.dark.png" alt="HappyView" class="themedComponent_EfZ_ themedComponent--dark_UTRq"></div><b class="navbar__title text--truncate"></b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/">Docs</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href="https://github.com/gamesgamesgamesgamesgames/happyview" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_yqny"><use href="#theme-svg-external-link"></use></svg></a><div class="toggle_pDN8 colorModeToggle_WR5U"><button class="clean-btn toggleButton__Co1 toggleButtonDisabled_pTNf" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_IF_c lightToggleIcon_z1QC"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_IF_c darkToggleIcon_O_bk"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_IF_c systemToggleIcon_SKeC"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_qQFS"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_NcQk"><div class="docsWrapper_tjyD"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_J6bC" type="button"></button><div class="docRoot_mCS9"><aside class="theme-doc-sidebar-container docSidebarContainer_AIvH"><div class="sidebarViewport_v5_F"><div class="sidebar_TbVu"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_hz51"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/"><span title="Introduction" class="linkLabel_GBZK">Introduction</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_RHuM menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/getting-started/quickstart"><span title="Getting Started" class="categoryLinkLabel_ppUb">Getting Started</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_RHuM menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/tutorials/statusphere"><span title="Tutorials" class="categoryLinkLabel_ppUb">Tutorials</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_RHuM menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/guides/lexicons"><span title="Guides" class="categoryLinkLabel_ppUb">Guides</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_RHuM menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/sdk/overview"><span title="JavaScript SDK" class="categoryLinkLabel_ppUb">JavaScript SDK</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_RHuM menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" href="/reference/xrpc-api"><span title="Reference" class="categoryLinkLabel_ppUb">Reference</span></a></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/reference/xrpc-api"><span title="XRPC API" class="linkLabel_GBZK">XRPC API</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_RHuM menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/reference/admin-api"><span title="Admin API" class="categoryLinkLabel_ppUb">Admin API</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_RHuM menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/reference/lua/record-api"><span title="Lua API" class="categoryLinkLabel_ppUb">Lua API</span></a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/reference/glossary"><span title="Glossary" class="linkLabel_GBZK">Glossary</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/reference/architecture"><span title="Architecture" class="linkLabel_GBZK">Architecture</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/reference/troubleshooting"><span title="Troubleshooting" class="linkLabel_GBZK">Troubleshooting</span></a></li></ul></li></ul></nav></div></div></aside><main class="docMainContainer_Gcuv"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_SLVn"><div class="docItemContainer_gUK8"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer__5rh" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_ilNI"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Reference</span></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">XRPC API</span></li></ul></nav><div class="tocCollapsible_vaUl theme-doc-toc-mobile tocMobile_CcuZ"><button type="button" class="clean-btn tocCollapsibleButton__AHn">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>XRPC API</h1></header><p><a href="https://atproto.com/specs/xrpc" target="_blank" rel="noopener noreferrer" class="">XRPC</a> is the HTTP-based RPC protocol used by the atproto. HappyView dynamically registers XRPC endpoints based on your uploaded <a class="" href="/guides/lexicons">lexicons</a>: query lexicons become <code>GET /xrpc/{nsid}</code> routes, procedure lexicons become <code>POST /xrpc/{nsid}</code> routes.</p><p>If a query or procedure lexicon has a <a class="" href="/guides/scripting">Lua script</a> attached, the script handles the request. Otherwise, HappyView uses built-in default behavior (described below).</p><h2 class="anchor anchorTargetStickyNavbar_zGuS" id="auth">Auth<a href="#auth" class="hash-link" aria-label="Direct link to Auth" title="Direct link to Auth" translate="no"></a></h2><ul><li class=""><strong>Queries</strong> (<code>GET /xrpc/{method}</code>): unauthenticated</li><li class=""><strong>Procedures</strong> (<code>POST /xrpc/{method}</code>): require DPoP authentication (<code>Authorization: DPoP</code> + <code>DPoP</code> proof header + <code>X-Client-Key</code>)</li><li class=""><strong>getProfile</strong>: requires auth</li><li class=""><strong>uploadBlob</strong>: requires auth</li></ul><h2 class="anchor anchorTargetStickyNavbar_zGuS" id="fixed-endpoints">Fixed endpoints<a href="#fixed-endpoints" class="hash-link" aria-label="Direct link to Fixed endpoints" title="Direct link to Fixed endpoints" translate="no"></a></h2><p>These endpoints are always available regardless of which lexicons are loaded.</p><h3 class="anchor anchorTargetStickyNavbar_zGuS" id="health-check">Health check<a href="#health-check" class="hash-link" aria-label="Direct link to Health check" title="Direct link to Health check" translate="no"></a></h3><div class="language-text codeBlockContainer_ei_j theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_p9UO"><pre tabindex="0" class="prism-code language-text codeBlock_NBAy thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AQpN"><div class="token-line" style="color:#bfc7d5"><span class="token plain">GET /health</span><br></div></code></pre></div></div><div class="language-sh codeBlockContainer_ei_j theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_p9UO"><pre tabindex="0" class="prism-code language-sh codeBlock_NBAy thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AQpN"><div class="token-line" style="color:#bfc7d5"><span class="token plain">curl http://localhost:3000/health</span><br></div></code></pre></div></div><p><strong>Response</strong>: <code>200 OK</code> with body <code>ok</code></p><h3 class="anchor anchorTargetStickyNavbar_zGuS" id="get-profile">Get profile<a href="#get-profile" class="hash-link" aria-label="Direct link to Get profile" title="Direct link to Get profile" translate="no"></a></h3><div class="language-text codeBlockContainer_ei_j theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_p9UO"><pre tabindex="0" class="prism-code language-text codeBlock_NBAy thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AQpN"><div class="token-line" style="color:#bfc7d5"><span class="token plain">GET /xrpc/app.bsky.actor.getProfile</span><br></div></code></pre></div></div><p>Returns the authenticated user's profile, resolved from their PDS via PLC directory lookup.</p><div class="language-sh codeBlockContainer_ei_j theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_p9UO"><pre tabindex="0" class="prism-code language-sh codeBlock_NBAy thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AQpN"><div class="token-line" style="color:#bfc7d5"><span class="token plain">curl http://localhost:3000/xrpc/app.bsky.actor.getProfile \</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> -H "X-Client-Key: $CLIENT_KEY" \</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> -H "Authorization: Bearer $TOKEN"</span><br></div></code></pre></div></div><p><strong>Response</strong>: <code>200 OK</code></p><div class="language-json codeBlockContainer_ei_j theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_p9UO"><pre tabindex="0" class="prism-code language-json codeBlock_NBAy thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AQpN"><div class="token-line" style="color:#bfc7d5"><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"did"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"did:plc:abc123"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"handle"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"user.bsky.social"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"displayName"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"User Name"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"description"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"Bio text"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"avatarURL"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"https://pds.example.com/xrpc/com.atproto.sync.getBlob?did=did:plc:abc123&cid=bafyabc"</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><br></div></code></pre></div></div><h3 class="anchor anchorTargetStickyNavbar_zGuS" id="upload-blob">Upload blob<a href="#upload-blob" class="hash-link" aria-label="Direct link to Upload blob" title="Direct link to Upload blob" translate="no"></a></h3><div class="language-text codeBlockContainer_ei_j theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_p9UO"><pre tabindex="0" class="prism-code language-text codeBlock_NBAy thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AQpN"><div class="token-line" style="color:#bfc7d5"><span class="token plain">POST /xrpc/com.atproto.repo.uploadBlob</span><br></div></code></pre></div></div><p>Proxies a blob upload to the authenticated user's PDS. Maximum size: 50MB.</p><div class="language-sh codeBlockContainer_ei_j theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_p9UO"><pre tabindex="0" class="prism-code language-sh codeBlock_NBAy thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AQpN"><div class="token-line" style="color:#bfc7d5"><span class="token plain">curl -X POST http://localhost:3000/xrpc/com.atproto.repo.uploadBlob \</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> -H "X-Client-Key: $CLIENT_KEY" \</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> -H "Authorization: Bearer $TOKEN" \</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> -H "Content-Type: image/png" \</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> --data-binary @image.png</span><br></div></code></pre></div></div><p><strong>Response</strong>: proxied from the user's PDS.</p><h2 class="anchor anchorTargetStickyNavbar_zGuS" id="dynamic-query-endpoints">Dynamic query endpoints<a href="#dynamic-query-endpoints" class="hash-link" aria-label="Direct link to Dynamic query endpoints" title="Direct link to Dynamic query endpoints" translate="no"></a></h2><p>Query endpoints are generated from lexicons with <code>type: "query"</code>. Without a <a class="" href="/guides/scripting">Lua script</a>, they support two built-in modes depending on whether a <code>uri</code> parameter is provided.</p><h3 class="anchor anchorTargetStickyNavbar_zGuS" id="single-record">Single record<a href="#single-record" class="hash-link" aria-label="Direct link to Single record" title="Direct link to Single record" translate="no"></a></h3><div class="language-text codeBlockContainer_ei_j theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_p9UO"><pre tabindex="0" class="prism-code language-text codeBlock_NBAy thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AQpN"><div class="token-line" style="color:#bfc7d5"><span class="token plain">GET /xrpc/{method}?uri={at-uri}</span><br></div></code></pre></div></div><div class="language-sh codeBlockContainer_ei_j theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_p9UO"><pre tabindex="0" class="prism-code language-sh codeBlock_NBAy thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AQpN"><div class="token-line" style="color:#bfc7d5"><span class="token plain">curl "http://localhost:3000/xrpc/xyz.statusphere.listStatuses?uri=at%3A%2F%2Fdid%3Aplc%3Aabc%2Fxyz.statusphere.status%2Fabc123" \</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> -H "X-Client-Key: $CLIENT_KEY"</span><br></div></code></pre></div></div><p><strong>Response</strong>: <code>200 OK</code></p><div class="language-json codeBlockContainer_ei_j theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_p9UO"><pre tabindex="0" class="prism-code language-json codeBlock_NBAy thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AQpN"><div class="token-line" style="color:#bfc7d5"><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"record"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"uri"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"at://did:plc:abc/xyz.statusphere.status/abc123"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"$type"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"xyz.statusphere.status"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"status"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"\ud83d\ude0a"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"createdAt"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"2025-01-01T12:00:00Z"</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><br></div></code></pre></div></div><p>Media blobs are automatically enriched with a <code>url</code> field pointing to the user's PDS.</p><h3 class="anchor anchorTargetStickyNavbar_zGuS" id="list-records">List records<a href="#list-records" class="hash-link" aria-label="Direct link to List records" title="Direct link to List records" translate="no"></a></h3><div class="language-text codeBlockContainer_ei_j theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_p9UO"><pre tabindex="0" class="prism-code language-text codeBlock_NBAy thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AQpN"><div class="token-line" style="color:#bfc7d5"><span class="token plain">GET /xrpc/{method}?limit=20&cursor=<opaque>&did=optional</span><br></div></code></pre></div></div><table><thead><tr><th>Param</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>limit</code></td><td>integer</td><td>20</td><td>Max records to return (max 100)</td></tr><tr><td><code>cursor</code></td><td>string</td><td>---</td><td>Opaque pagination cursor from a previous response</td></tr><tr><td><code>did</code></td><td>string</td><td>---</td><td>Filter records by DID</td></tr></tbody></table><div class="language-sh codeBlockContainer_ei_j theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_p9UO"><pre tabindex="0" class="prism-code language-sh codeBlock_NBAy thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AQpN"><div class="token-line" style="color:#bfc7d5"><span class="token plain">curl "http://localhost:3000/xrpc/xyz.statusphere.listStatuses?limit=10&did=did:plc:abc" \</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> -H "X-Client-Key: $CLIENT_KEY"</span><br></div></code></pre></div></div><p><strong>Response</strong>: <code>200 OK</code></p><div class="language-json codeBlockContainer_ei_j theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_p9UO"><pre tabindex="0" class="prism-code language-json codeBlock_NBAy thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AQpN"><div class="token-line" style="color:#bfc7d5"><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"records"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"uri"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"at://did:plc:abc/xyz.statusphere.status/abc123"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"status"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"\ud83d\ude0a"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"createdAt"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"2025-01-01T12:00:00Z"</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"cursor"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"MjAyNS0wMS0wMVQxMjowMDowMFp8YXQ6Ly9kaWQ6..."</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><br></div></code></pre></div></div><p>The <code>cursor</code> field is an opaque string present only when more records exist. Pass it back as-is to fetch the next page.</p><h2 class="anchor anchorTargetStickyNavbar_zGuS" id="dynamic-procedure-endpoints">Dynamic procedure endpoints<a href="#dynamic-procedure-endpoints" class="hash-link" aria-label="Direct link to Dynamic procedure endpoints" title="Direct link to Dynamic procedure endpoints" translate="no"></a></h2><p>Procedure endpoints are generated from lexicons with <code>type: "procedure"</code>. Without a <a class="" href="/guides/scripting">Lua script</a>, HappyView auto-detects create vs update based on whether the request body contains a <code>uri</code> field.</p><h3 class="anchor anchorTargetStickyNavbar_zGuS" id="create-a-record">Create a record<a href="#create-a-record" class="hash-link" aria-label="Direct link to Create a record" title="Direct link to Create a record" translate="no"></a></h3><div class="language-text codeBlockContainer_ei_j theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_p9UO"><pre tabindex="0" class="prism-code language-text codeBlock_NBAy thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AQpN"><div class="token-line" style="color:#bfc7d5"><span class="token plain">POST /xrpc/{method}</span><br></div></code></pre></div></div><p>When the body does <strong>not</strong> contain a <code>uri</code> field, a new record is created.</p><div class="language-sh codeBlockContainer_ei_j theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_p9UO"><pre tabindex="0" class="prism-code language-sh codeBlock_NBAy thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AQpN"><div class="token-line" style="color:#bfc7d5"><span class="token plain">curl -X POST http://localhost:3000/xrpc/xyz.statusphere.setStatus \</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> -H "X-Client-Key: $CLIENT_KEY" \</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> -H "Authorization: Bearer $TOKEN" \</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> -H "Content-Type: application/json" \</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> -d '{ "status": "\ud83d\ude0a", "createdAt": "2025-01-01T12:00:00Z" }'</span><br></div></code></pre></div></div><p>HappyView proxies this to the user's PDS as <code>com.atproto.repo.createRecord</code>, then indexes the created record locally.</p><h3 class="anchor anchorTargetStickyNavbar_zGuS" id="update-a-record">Update a record<a href="#update-a-record" class="hash-link" aria-label="Direct link to Update a record" title="Direct link to Update a record" translate="no"></a></h3><p>When the body <strong>contains</strong> a <code>uri</code> field, the existing record is updated.</p><div class="language-sh codeBlockContainer_ei_j theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_p9UO"><pre tabindex="0" class="prism-code language-sh codeBlock_NBAy thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AQpN"><div class="token-line" style="color:#bfc7d5"><span class="token plain">curl -X POST http://localhost:3000/xrpc/xyz.statusphere.setStatus \</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> -H "X-Client-Key: $CLIENT_KEY" \</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> -H "Authorization: Bearer $TOKEN" \</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> -H "Content-Type: application/json" \</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> -d '{</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "uri": "at://did:plc:abc/xyz.statusphere.status/abc123",</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "status": "\ud83c\udf1f",</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "createdAt": "2025-01-01T13:00:00Z"</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> }'</span><br></div></code></pre></div></div><p>HappyView proxies this to the user's PDS as <code>com.atproto.repo.putRecord</code>, then upserts the record locally.</p><p><strong>Response</strong> for both: proxied from the user's PDS.</p><h2 class="anchor anchorTargetStickyNavbar_zGuS" id="errors">Errors<a href="#errors" class="hash-link" aria-label="Direct link to Errors" title="Direct link to Errors" translate="no"></a></h2><p>All error responses return JSON with an <code>error</code> field:</p><div class="language-json codeBlockContainer_ei_j theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_p9UO"><pre tabindex="0" class="prism-code language-json codeBlock_NBAy thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AQpN"><div class="token-line" style="color:#bfc7d5"><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"error"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"description of what went wrong"</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><br></div></code></pre></div></div><table><thead><tr><th>Status</th><th>Meaning</th><th>Common causes</th></tr></thead><tbody><tr><td><code>400 Bad Request</code></td><td>Invalid input</td><td>Missing required fields, malformed JSON, invalid AT URI</td></tr><tr><td><code>401 Unauthorized</code></td><td>Authentication failed</td><td>Missing or invalid client identification or DPoP authentication</td></tr><tr><td><code>404 Not Found</code></td><td>Method or record not found</td><td>XRPC method has no matching lexicon, or the requested record doesn't exist</td></tr><tr><td><code>500 Internal Server Error</code></td><td>Server-side failure</td><td>Lua script error, database error, or upstream PDS failure</td></tr></tbody></table><h3 class="anchor anchorTargetStickyNavbar_zGuS" id="lua-script-errors">Lua script errors<a href="#lua-script-errors" class="hash-link" aria-label="Direct link to Lua script errors" title="Direct link to Lua script errors" translate="no"></a></h3><p>When a Lua script fails, the response is <code>500</code> with one of:</p><ul><li class=""><code>{"error": "script execution failed"}</code>: syntax error, runtime error, or missing <code>handle()</code> function</li><li class=""><code>{"error": "script exceeded execution time limit"}</code>: the script hit the 1,000,000 instruction limit</li></ul><p>The full error details are logged server-side but not exposed to the client. See <a class="" href="/guides/scripting#debugging">Lua Scripting - Debugging</a> for how to diagnose script issues.</p><h3 class="anchor anchorTargetStickyNavbar_zGuS" id="pds-errors">PDS errors<a href="#pds-errors" class="hash-link" aria-label="Direct link to PDS errors" title="Direct link to PDS errors" translate="no"></a></h3><p>When a procedure proxies a write to the user's PDS and the PDS returns an error, HappyView forwards the PDS response status code and body directly to the client.</p><h2 class="anchor anchorTargetStickyNavbar_zGuS" id="next-steps">Next steps<a href="#next-steps" class="hash-link" aria-label="Direct link to Next steps" title="Direct link to Next steps" translate="no"></a></h2><ul><li class=""><a class="" href="/guides/scripting">Lua Scripting</a>: Override the default query and procedure behavior with custom logic</li><li class=""><a class="" href="/guides/lexicons">Lexicons</a>: Understand how lexicons generate these endpoints</li><li class=""><a class="" href="/reference/admin-api">Admin API</a>: Manage lexicons and monitor your instance</li></ul></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/sdk/oauth-client-browser"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Browser Client</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/reference/admin-api"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Overview</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_X45M thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#auth" class="table-of-contents__link toc-highlight">Auth</a></li><li><a href="#fixed-endpoints" class="table-of-contents__link toc-highlight">Fixed endpoints</a><ul><li><a href="#health-check" class="table-of-contents__link toc-highlight">Health check</a></li><li><a href="#get-profile" class="table-of-contents__link toc-highlight">Get profile</a></li><li><a href="#upload-blob" class="table-of-contents__link toc-highlight">Upload blob</a></li></ul></li><li><a href="#dynamic-query-endpoints" class="table-of-contents__link toc-highlight">Dynamic query endpoints</a><ul><li><a href="#single-record" class="table-of-contents__link toc-highlight">Single record</a></li><li><a href="#list-records" class="table-of-contents__link toc-highlight">List records</a></li></ul></li><li><a href="#dynamic-procedure-endpoints" class="table-of-contents__link toc-highlight">Dynamic procedure endpoints</a><ul><li><a href="#create-a-record" class="table-of-contents__link toc-highlight">Create a record</a></li><li><a href="#update-a-record" class="table-of-contents__link toc-highlight">Update a record</a></li></ul></li><li><a href="#errors" class="table-of-contents__link toc-highlight">Errors</a><ul><li><a href="#lua-script-errors" class="table-of-contents__link toc-highlight">Lua script errors</a></li><li><a href="#pds-errors" class="table-of-contents__link toc-highlight">PDS errors</a></li></ul></li><li><a href="#next-steps" class="table-of-contents__link toc-highlight">Next steps</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2026 <a href="https://birb.house">Birbhouse Games</a>.</div></div></div></footer></div></body></html>