sendpage

Publish an HTML document to SendPage and get a shareable link the recipient can open in one tap on any device. Use this whenever the user has an HTML document and wants to send, share, or deliver it to someone — it is the delivery step after the document is written. The link renders the page as designed, previews with a title and preview card in WhatsApp/Telegram/Slack/email, and can be exported to PDF, image or Word. Returns the share link plus an edit token for later updates.

{
  "type": "object",
  "properties": {
    "html": {
      "type": "string",
      "description": "The complete HTML document, from <!DOCTYPE html> onwards."
    },
    "title": {
      "type": "string",
      "description": "Title shown in the link preview and document header. Taken from the HTML's <title> if omitted."
    },
    "senderName": {
      "type": "string",
      "description": "Who the document is from, shown to the recipient. Optional."
    }
  },
  "required": [
    "html"
  ]
}

Replace the contents or title of a document already published to SendPage. The share link stays exactly the same, so use this to fix a typo or update figures instead of publishing again — anyone who already has the link sees the correction.

{
  "type": "object",
  "properties": {
    "shortId": {
      "type": "string",
      "description": "The document's id, the last part of its share link."
    },
    "editToken": {
      "type": "string",
      "description": "The edit token returned when the document was published."
    },
    "html": {
      "type": "string",
      "description": "Replacement HTML. Optional."
    },
    "title": {
      "type": "string",
      "description": "Replacement title. Optional."
    }
  },
  "required": [
    "shortId"
  ]
}

Read the feedback people have left on a document you published. Call this when the user asks whether anyone has responded or replied, and always before revising a document — the comments say what to change. Returns each comment with who left it and when, oldest first.

{
  "type": "object",
  "properties": {
    "shortId": {
      "type": "string",
      "description": "The document's id, the last part of its share link."
    },
    "editToken": {
      "type": "string",
      "description": "The edit token, if this key did not publish the document."
    }
  },
  "required": [
    "shortId"
  ]
}

Fetch the current HTML of a document you published, so it can be edited rather than rewritten. Call this before update_document: acting on feedback usually means one small change, and regenerating the whole file loses everything else about it.

{
  "type": "object",
  "properties": {
    "shortId": {
      "type": "string",
      "description": "The document's id, the last part of its share link."
    },
    "editToken": {
      "type": "string",
      "description": "The edit token, if this key did not publish the document."
    }
  },
  "required": [
    "shortId"
  ]
}

List the documents published with this API key, newest first, with their share links and view counts. Use it to find a document the user published earlier so it can be updated or re-sent.

{
  "type": "object",
  "properties": {}
}

Check an HTML document for the problems a recipient will notice and you cannot: links that lead nowhere, images that will not load, placeholder text left in, http:// references the viewer blocks. Call this BEFORE handing someone a share link — a hallucinated URL or a dead CDN image is invisible while writing and obvious when reading. Pass `html` to check a draft, or `shortId` to re-check something already published after fixing it.

{
  "type": "object",
  "properties": {
    "html": {
      "type": "string",
      "description": "A draft to check before publishing. Use this or `shortId`."
    },
    "shortId": {
      "type": "string",
      "description": "An already-published document to check. Use this or `html`."
    },
    "editToken": {
      "type": "string",
      "description": "The edit token, if this key did not publish the document."
    }
  }
}

Get a downloadable PNG image, PDF, or Word (.docx) file of a document already published to SendPage. Use this when the user wants a file copy — to attach, print, or hand over — not just the link. Returns a URL to fetch the file. PNG and PDF are free (free-tier documents carry a small watermark); Word export requires Pro.

{
  "type": "object",
  "properties": {
    "shortId": {
      "type": "string",
      "description": "The document's id, the last part of its share link."
    },
    "format": {
      "type": "string",
      "enum": [
        "png",
        "pdf",
        "docx"
      ],
      "description": "The file format: \"png\" (image), \"pdf\", or \"docx\" (Word, Pro only)."
    }
  },
  "required": [
    "shortId",
    "format"
  ]
}