{
  "generatedAt": "2026-07-14T16:49:35.268Z",
  "site": "https://fileshub-docs.zaions.com",
  "description": "Raw Markdown mirror of every FilesHub documentation page. Each url returns the un-rendered .md (front matter included). Built for AI coding agents. See also /openapi.json.",
  "count": 25,
  "files": [
    {
      "path": "about-the-author.md",
      "url": "https://fileshub-docs.zaions.com/raw/about-the-author.md",
      "title": "About the author",
      "description": "FilesHub is built and maintained by Ahsan Mahmood, a senior full-stack engineer and the author of these docs."
    },
    {
      "path": "api/delete-object.md",
      "url": "https://fileshub-docs.zaions.com/raw/api/delete-object.md",
      "title": "Delete an object",
      "description": "DELETE /api/v1/objects/{public_id} permanently removes a FilesHub object — both the database record and the stored file. Requires a write-permission API key."
    },
    {
      "path": "api/email-schedules.md",
      "url": "https://fileshub-docs.zaions.com/raw/api/email-schedules.md",
      "title": "Recurring email schedules",
      "description": "Define cron-based recurring emails in FilesHub — create, list, update, pause, delete, and run-now — each sending to up to 50 recipients per run from a template or raw content."
    },
    {
      "path": "api/email-templates.md",
      "url": "https://fileshub-docs.zaions.com/raw/api/email-templates.md",
      "title": "Email templates",
      "description": "Manage reusable email templates in FilesHub — list them, and create, update, or delete them over the API — then send with template + variables."
    },
    {
      "path": "api/emails-send.md",
      "url": "https://fileshub-docs.zaions.com/raw/api/emails-send.md",
      "title": "Send an email",
      "description": "POST /api/v1/emails/send sends transactional email through FilesHub — raw HTML/text or a saved template, from one of three verified domains, queued by default with a job to poll."
    },
    {
      "path": "api/errors-and-limits.md",
      "url": "https://fileshub-docs.zaions.com/raw/api/errors-and-limits.md",
      "title": "Errors & limits",
      "description": "FilesHub returns a consistent JSON error envelope with an HTTP status code, and applies per-key rate limits and an upload size cap. This page lists every status code and limit."
    },
    {
      "path": "api/get-object.md",
      "url": "https://fileshub-docs.zaions.com/raw/api/get-object.md",
      "title": "Get / download an object",
      "description": "GET /api/v1/objects/{public_id} streams a stored file back from FilesHub. Public objects need no key; private objects require a read-permission key from the same project."
    },
    {
      "path": "api/jobs.md",
      "url": "https://fileshub-docs.zaions.com/raw/api/jobs.md",
      "title": "Job status",
      "description": "Poll GET /api/v1/jobs/{job_id} to track a queued FilesHub operation (like a queued email send) through queued → completed or failed, with attempts and result."
    },
    {
      "path": "api/list-objects.md",
      "url": "https://fileshub-docs.zaions.com/raw/api/list-objects.md",
      "title": "List objects",
      "description": "GET /api/v1/objects returns a paginated list of your project's stored files, newest first, with an optional visibility filter. Requires a read-permission API key."
    },
    {
      "path": "api/openapi.md",
      "url": "https://fileshub-docs.zaions.com/raw/api/openapi.md",
      "title": "OpenAPI spec (for AI agents & codegen)",
      "description": "FilesHub ships a machine-readable OpenAPI 3.1 spec at /openapi.json covering the core APIs — feed it to Claude Code, Codex, or an OpenAPI generator to integrate without guesswork."
    },
    {
      "path": "api/overview.md",
      "url": "https://fileshub-docs.zaions.com/raw/api/overview.md",
      "title": "API overview",
      "description": "The FilesHub API under /api/v1 covers file objects, transactional email, jobs, and 40+ developer utilities — all authenticated with an X-API-Key header. This page maps the contract."
    },
    {
      "path": "api/upload-object.md",
      "url": "https://fileshub-docs.zaions.com/raw/api/upload-object.md",
      "title": "Upload an object",
      "description": "POST /api/v1/objects uploads a multipart file to FilesHub and returns a 201 with the object's ULID, public URL, and metadata. Supports visibility and optional auto-expiry."
    },
    {
      "path": "api/utilities-index.md",
      "url": "https://fileshub-docs.zaions.com/raw/api/utilities-index.md",
      "title": "Developer utilities index",
      "description": "A summarized index of FilesHub's stateless developer-utility endpoint groups — converters, hashing, encoding, generators, and more — all under /api/v1 with an X-API-Key."
    },
    {
      "path": "api/version-health.md",
      "url": "https://fileshub-docs.zaions.com/raw/api/version-health.md",
      "title": "Version & health",
      "description": "GET /api/health and GET /api/version are FilesHub's public, no-auth status endpoints — health reports database connectivity, version returns the deployed backend build marker."
    },
    {
      "path": "changelog.md",
      "url": "https://fileshub-docs.zaions.com/raw/changelog.md",
      "title": "Changelog",
      "description": "Notable changes to the FilesHub documentation site, latest first."
    },
    {
      "path": "faq.md",
      "url": "https://fileshub-docs.zaions.com/raw/faq.md",
      "title": "FAQ",
      "description": "Frequently asked questions about FilesHub — what it is, how to authenticate, public vs private files, size limits, SDKs, deleting files, and how it compares to S3 or Firebase Storage."
    },
    {
      "path": "getting-started/api-key-restrictions.md",
      "url": "https://fileshub-docs.zaions.com/raw/getting-started/api-key-restrictions.md",
      "title": "API key restrictions (ship a key in a frontend)",
      "description": "Restrict a FilesHub API key to your own web origins, Android package + signing certificate, or iOS bundle id — so you can embed the key in a React/mobile app without a proxy backend."
    },
    {
      "path": "getting-started/authentication.md",
      "url": "https://fileshub-docs.zaions.com/raw/getting-started/authentication.md",
      "title": "Authentication",
      "description": "FilesHub authenticates every request with an X-API-Key header. Keys are per project, carry read and write permissions, and can be restricted to specific web origins or mobile app ids."
    },
    {
      "path": "getting-started/file-visibility.md",
      "url": "https://fileshub-docs.zaions.com/raw/getting-started/file-visibility.md",
      "title": "File visibility (public vs private)",
      "description": "Each FilesHub object is public or private. Public objects are downloadable by anyone at their URL; private objects require a read-permission API key from the same project."
    },
    {
      "path": "getting-started/quick-start.md",
      "url": "https://fileshub-docs.zaions.com/raw/getting-started/quick-start.md",
      "title": "Quick Start",
      "description": "Upload your first file to FilesHub in about five minutes — get an API key, POST a multipart file with your X-API-Key, and use the returned public URL."
    },
    {
      "path": "guides/browser-and-mobile-uploads.md",
      "url": "https://fileshub-docs.zaions.com/raw/guides/browser-and-mobile-uploads.md",
      "title": "Browser & mobile uploads",
      "description": "How to upload to FilesHub safely from a browser or a mobile app — multipart form data, restricted keys scoped to your domain or bundle id, and the backend-proxy alternative."
    },
    {
      "path": "guides/integrate-from-any-app.md",
      "url": "https://fileshub-docs.zaions.com/raw/guides/integrate-from-any-app.md",
      "title": "Integrate from any app",
      "description": "Copy-paste FilesHub integration for JavaScript/TypeScript, React, PHP/Laravel, and mobile — upload a file, store the returned URL, render it, and clean it up on delete."
    },
    {
      "path": "intro.md",
      "url": "https://fileshub-docs.zaions.com/raw/intro.md",
      "title": "Introduction",
      "description": "FilesHub is a zero-cost file-storage and developer-utility API — upload a file over HTTP with an X-API-Key header, get a stable public URL, then list, download, or delete it."
    },
    {
      "path": "platform-services.md",
      "url": "https://fileshub-docs.zaions.com/raw/platform-services.md",
      "title": "Platform services (beyond storage)",
      "description": "Beyond file storage, FilesHub exposes 50+ stateless developer-utility endpoints on the same base URL and X-API-Key — hashing, encoding, converters, QR codes, short URLs, OTP, a vault, and image/PDF processing."
    },
    {
      "path": "privacy.md",
      "url": "https://fileshub-docs.zaions.com/raw/privacy.md",
      "title": "Privacy",
      "description": "Privacy notice for the FilesHub documentation site and the FilesHub API — what the docs site collects, what the API stores, and how to get data removed."
    }
  ]
}