# uploadthefile API documentation ## API Docs - Pages [Create a page](https://api.uploadthefile.com/create-a-page-38697742e0.md): Upload an `.html` file or a `.zip` static site and get a live URL. - Pages [Update a page in place](https://api.uploadthefile.com/update-a-page-in-place-38697743e0.md): Replace the files of a page you own, keeping the same URL. The target page - Pages [List pages](https://api.uploadthefile.com/list-pages-38697744e0.md): List the caller's hosted pages and sites, newest first. - Pages [Get a page](https://api.uploadthefile.com/get-a-page-38697745e0.md): Fetch a single page you own, addressed by its id or public name. - Pages [Rename a page](https://api.uploadthefile.com/rename-a-page-38697746e0.md): Change a page's public subdomain name. Only the public name changes — the - Pages [Delete a page](https://api.uploadthefile.com/delete-a-page-38697747e0.md): Permanently delete a page you own. - Pages [Unzip & host a page](https://api.uploadthefile.com/unzip-host-a-page-38697748e0.md): Promote one of your downloadable-ZIP pages (`kind: zip`) into a hosted - Pages [Get page password state](https://api.uploadthefile.com/get-page-password-state-38697749e0.md): Whether the page is password-protected, and whether this caller may enable protection. - Pages [Set page password](https://api.uploadthefile.com/set-page-password-38697750e0.md): Set or change the page's link password (6–72 chars). Enabling protection on - Pages [Remove page password](https://api.uploadthefile.com/remove-page-password-38697751e0.md): Remove password protection from the page (always allowed). - Pages [Get email-gate config](https://api.uploadthefile.com/get-email-gate-config-38697752e0.md): The page's email-capture gate state, prompt, consent flag, capture count, and whether this caller may enable it. - Pages [Configure email-gate](https://api.uploadthefile.com/configure-email-gate-38697753e0.md): Enable/disable the email-capture gate and optionally set the prompt message - Pages [Disable email-gate](https://api.uploadthefile.com/disable-email-gate-38697754e0.md): Turn the email-capture gate off (always allowed). Captured emails are kept. - Pages [List or export captured emails](https://api.uploadthefile.com/list-or-export-captured-emails-38697755e0.md): The emails captured by the page's email gate. Returns JSON by default, or a - Pages [Get page display mode](https://api.uploadthefile.com/get-page-display-mode-38697756e0.md): The page's display mode and whether display mode applies to its file kind. - Pages [Set page display mode](https://api.uploadthefile.com/set-page-display-mode-38697757e0.md): Set how a renderable single-file page is shown: `preview`, `preview_download`, - Pages [Get PDF chat availability](https://api.uploadthefile.com/get-pdf-chat-availability-38697758e0.md): Whether chat is enabled for the page (a PDF) and the document extraction status. - Pages [Enable PDF chat](https://api.uploadthefile.com/enable-pdf-chat-38697759e0.md): Enable AI chat for a PDF page. Extracts the document text inline so chat is - Pages [Disable PDF chat](https://api.uploadthefile.com/disable-pdf-chat-38697760e0.md): Turn chat off (always allowed). Extracted text is kept for a quick re-enable. - Pages [Bulk delete pages](https://api.uploadthefile.com/bulk-delete-pages-38697761e0.md): Delete several of your own pages in one request. Ownership is enforced - Short links [List short links](https://api.uploadthefile.com/list-short-links-38697762e0.md): List the caller's short links, newest first. - Short links [Create a short link](https://api.uploadthefile.com/create-a-short-link-38697763e0.md): Create a short link to an arbitrary public `http(s)` destination. The - Short links [Bulk update short links](https://api.uploadthefile.com/bulk-update-short-links-38697764e0.md): Disable, enable, or delete several of your own short links in one request. - Short links [Get a short link](https://api.uploadthefile.com/get-a-short-link-38697765e0.md): Fetch a single short link you own. - Short links [Update a short link](https://api.uploadthefile.com/update-a-short-link-38697766e0.md): Update a short link you own. `disabled` (pause/resume) is always allowed; - Short links [Delete a short link](https://api.uploadthefile.com/delete-a-short-link-38697767e0.md): Permanently delete a short link you own. - Short links [Get link click history](https://api.uploadthefile.com/get-link-click-history-38697768e0.md): Daily click history for one of your short links over the last 30 days, - Domains [List custom domains](https://api.uploadthefile.com/list-custom-domains-38697769e0.md): The caller's connected custom domains. 404 if the domains feature is disabled. - Domains [Connect a custom domain](https://api.uploadthefile.com/connect-a-custom-domain-38697770e0.md): Connect a globally-unique domain to one of your pages (status `pending` until - Domains [Search domain availability](https://api.uploadthefile.com/search-domain-availability-38697771e0.md): Search availability + customer pricing for a domain query (fans out to the - Domains [Rebind a domain to a different page](https://api.uploadthefile.com/rebind-a-domain-to-a-different-page-38697772e0.md): Repoint a domain you own at a different page, or pass `pageId: null` to unbind. - Domains [Disconnect a domain](https://api.uploadthefile.com/disconnect-a-domain-38697773e0.md): Remove a domain connection you own. - Account [Get account, limits, and usage](https://api.uploadthefile.com/get-account-limits-and-usage-38697774e0.md): Return the caller's plan, **effective** limits (plan catalog plus any admin ## Schemas - [UploadCreateForm](https://api.uploadthefile.com/uploadcreateform-16056343d0.md): - [UploadUpdateForm](https://api.uploadthefile.com/uploadupdateform-16056344d0.md): - [SubdomainName](https://api.uploadthefile.com/subdomainname-16056345d0.md): - [RenamePageRequest](https://api.uploadthefile.com/renamepagerequest-16056346d0.md): - [CreateLinkRequest](https://api.uploadthefile.com/createlinkrequest-16056347d0.md): - [UpdateLinkRequest](https://api.uploadthefile.com/updatelinkrequest-16056348d0.md): - [BulkDeletePagesRequest](https://api.uploadthefile.com/bulkdeletepagesrequest-16056349d0.md): - [BulkLinkActionRequest](https://api.uploadthefile.com/bulklinkactionrequest-16056350d0.md): - [ClickPoint](https://api.uploadthefile.com/clickpoint-16056351d0.md): - [DisplayMode](https://api.uploadthefile.com/displaymode-16056352d0.md): - [SetDisplayModeRequest](https://api.uploadthefile.com/setdisplaymoderequest-16056353d0.md): - [SetPasswordRequest](https://api.uploadthefile.com/setpasswordrequest-16056354d0.md): - [SetEmailGateRequest](https://api.uploadthefile.com/setemailgaterequest-16056355d0.md): - [EmailCapture](https://api.uploadthefile.com/emailcapture-16056356d0.md): - [ConnectDomainRequest](https://api.uploadthefile.com/connectdomainrequest-16056357d0.md): - [RebindDomainRequest](https://api.uploadthefile.com/rebinddomainrequest-16056358d0.md): - [DomainConnection](https://api.uploadthefile.com/domainconnection-16056359d0.md): - [DomainSearchResult](https://api.uploadthefile.com/domainsearchresult-16056360d0.md): - [LinkCode](https://api.uploadthefile.com/linkcode-16056361d0.md): - [ExpiryOption](https://api.uploadthefile.com/expiryoption-16056362d0.md): - [ApiPage](https://api.uploadthefile.com/apipage-16056363d0.md): - [ShortLink](https://api.uploadthefile.com/shortlink-16056364d0.md): - [AccountInfo](https://api.uploadthefile.com/accountinfo-16056365d0.md): - [UploadResult](https://api.uploadthefile.com/uploadresult-16056366d0.md): - [HostResult](https://api.uploadthefile.com/hostresult-16056367d0.md): - [DeleteResult](https://api.uploadthefile.com/deleteresult-16056368d0.md): - [UpgradeNudge](https://api.uploadthefile.com/upgradenudge-16056369d0.md): - [Error](https://api.uploadthefile.com/error-16056370d0.md): - [UploadResultEnvelope](https://api.uploadthefile.com/uploadresultenvelope-16056371d0.md): - [PageEnvelope](https://api.uploadthefile.com/pageenvelope-16056372d0.md): - [PagesListEnvelope](https://api.uploadthefile.com/pageslistenvelope-16056373d0.md): - [HostEnvelope](https://api.uploadthefile.com/hostenvelope-16056374d0.md): - [DeleteEnvelope](https://api.uploadthefile.com/deleteenvelope-16056375d0.md): - [LinkEnvelope](https://api.uploadthefile.com/linkenvelope-16056376d0.md): - [LinksListEnvelope](https://api.uploadthefile.com/linkslistenvelope-16056377d0.md): - [AccountEnvelope](https://api.uploadthefile.com/accountenvelope-16056378d0.md): - [BulkDeletedEnvelope](https://api.uploadthefile.com/bulkdeletedenvelope-16056379d0.md): - [BulkAffectedEnvelope](https://api.uploadthefile.com/bulkaffectedenvelope-16056380d0.md): - [ClickSeriesEnvelope](https://api.uploadthefile.com/clickseriesenvelope-16056381d0.md): - [PagePasswordStateEnvelope](https://api.uploadthefile.com/pagepasswordstateenvelope-16056382d0.md): - [PagePasswordResultEnvelope](https://api.uploadthefile.com/pagepasswordresultenvelope-16056383d0.md): - [EmailGateStateEnvelope](https://api.uploadthefile.com/emailgatestateenvelope-16056384d0.md): - [EmailGateUpdatedEnvelope](https://api.uploadthefile.com/emailgateupdatedenvelope-16056385d0.md): - [EmailGateDisabledEnvelope](https://api.uploadthefile.com/emailgatedisabledenvelope-16056386d0.md): - [CapturesEnvelope](https://api.uploadthefile.com/capturesenvelope-16056387d0.md): - [DisplayModeStateEnvelope](https://api.uploadthefile.com/displaymodestateenvelope-16056388d0.md): - [DisplayModeResultEnvelope](https://api.uploadthefile.com/displaymoderesultenvelope-16056389d0.md): - [ChatAvailabilityEnvelope](https://api.uploadthefile.com/chatavailabilityenvelope-16056390d0.md): - [DomainsListEnvelope](https://api.uploadthefile.com/domainslistenvelope-16056391d0.md): - [DomainConnectionEnvelope](https://api.uploadthefile.com/domainconnectionenvelope-16056392d0.md): - [DomainDeletedEnvelope](https://api.uploadthefile.com/domaindeletedenvelope-16056393d0.md): - [DomainSearchEnvelope](https://api.uploadthefile.com/domainsearchenvelope-16056394d0.md):