SiteRender API

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "maxLength": 8192,
      "description": "The public URL to fetch (http or https, at most 8,192 characters)."
    },
    "format": {
      "enum": [
        "markdown",
        "text",
        "html"
      ],
      "type": "string",
      "default": "markdown",
      "description": "Output format. Prefer markdown."
    },
    "country": {
      "type": "string",
      "default": "us",
      "maxLength": 2,
      "minLength": 2,
      "description": "Fetch the page as seen from this country, e.g. 'de', 'gb', 'us'."
    },
    "verbosity": {
      "enum": [
        "compact",
        "full"
      ],
      "type": "string",
      "default": "compact",
      "description": "'compact' = main content only, 'full' = whole page body."
    },
    "max_characters": {
      "type": "integer",
      "default": 8000,
      "maximum": 100000,
      "minimum": 500,
      "description": "Maximum characters of content to return (default 8000, smaller than the REST API's 100000 to save context). Raise it when the content is cut."
    }
  }
}