doc.page PDF Extraction

Extract a PDF into clean Markdown and structured elements (headings, paragraphs). Returns the canonical ExtractedDocument object. mode "hybrid" runs a heavier semantic engine that also reconstructs tables and bounding boxes; the default "fast" engine is prose-only (low confidence.tables).

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "http(s) URL of the PDF to extract."
    },
    "outputs": {
      "type": "array",
      "description": "Subset of outputs to include. Default: markdown and elements.",
      "items": {
        "type": "string",
        "enum": [
          "markdown",
          "elements",
          "chunks",
          "images"
        ]
      }
    },
    "mode": {
      "type": "string",
      "enum": [
        "fast",
        "hybrid"
      ],
      "description": "fast = prose engine. hybrid = semantic engine with tables + bounding boxes when deployed; falls back to fast with a warning otherwise."
    },
    "chunkTokens": {
      "type": "integer",
      "description": "Target chunk size in tokens (when chunks are requested). Default 512."
    }
  },
  "required": [
    "url"
  ],
  "additionalProperties": false
}

Split a PDF into semantic chunks ready for embeddings (RAG). Each chunk carries its text, estimated tokens, starting page, section heading and the source element ids for citation.

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "http(s) URL of the PDF to chunk."
    },
    "maxTokens": {
      "type": "integer",
      "description": "Target chunk size in tokens. Default 512."
    }
  },
  "required": [
    "url"
  ],
  "additionalProperties": false
}

Return every table in a PDF as structured JSON (reconstructed rows and columns) with page and bounding box for verifiable citations. Uses the semantic (hybrid) engine.

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "http(s) URL of the PDF."
    }
  },
  "required": [
    "url"
  ],
  "additionalProperties": false
}

Publish a PDF as a tracked doc.page Doc Link and get back a shareable URL. The link belongs to the API key's account and also appears in its doc.page library. Requires an API key. Free plan: up to 3 active links; custom vanity slugs are premium-only. Optional expiry and open-notification toggle.

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "http(s) URL of the PDF to publish (max 25 MB)."
    },
    "name": {
      "type": "string",
      "description": "Display name in the library. Defaults to the filename."
    },
    "slug": {
      "type": "string",
      "description": "Custom vanity slug (premium plans only). Lowercase letters, digits and hyphens."
    },
    "expiresAt": {
      "type": "string",
      "description": "ISO 8601 date-time after which the link stops working. Omit for no expiry."
    },
    "notifyOnOpen": {
      "type": "boolean",
      "description": "Email the account owner on the first open. Default true."
    }
  },
  "required": [
    "url"
  ],
  "additionalProperties": false
}

List the Doc Links of the API key's account (id, slug, URL, name, disabled/expiry state, total views, last view). Use this to recover links created in earlier sessions before querying stats. Requires an API key.

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

Reading analytics for one Doc Link of the API key's account, by id or slug. Always returns the summary (total views, unique visitors, last visit). Premium plans additionally get countries, visitor companies (as_org) and per-page views + average dwell time; pass include:["visits"] for the recent visit rows. Requires an API key.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Doc Link item id (from create_doc_link or list_doc_links)."
    },
    "slug": {
      "type": "string",
      "description": "Doc Link slug — alternative to id."
    },
    "include": {
      "type": "array",
      "description": "Extra sections. \"visits\" adds the recent visit rows (enriched on premium plans).",
      "items": {
        "type": "string",
        "enum": [
          "visits"
        ]
      }
    }
  },
  "additionalProperties": false
}

Disable a Doc Link of the API key's account (by id or slug) so the public URL stops serving. The item and its stats remain in the library; on the free plan this frees an active-link slot. Requires an API key.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Doc Link item id."
    },
    "slug": {
      "type": "string",
      "description": "Doc Link slug — alternative to id."
    }
  },
  "additionalProperties": false
}