Skip to main content

Read a public URL

Acquire or expand bounded evidence from one public URL, authorized uploaded PDF, or prior read snapshot.

POST/api/research-tools/read-public-url
HTTP referenceScope search:runUpdated September 27, 2026

This page documents the canonical HTTP contract for this endpoint.

Provide exactly one of url, attachment_id, or read_id. find requires focus; a cursor is valid only for find/full. A read ID requires an explicit view. max_age_seconds applies only to URL acquisition. The default public URL behavior can use provider fallback under the documented reader policy; uploaded files and cached snapshot expansion do not re-acquire the source. Response data is source-dependent. Hard PDF bounds and defaults come from the current reader configuration.

Body parameters

  • url · optional

    string|null

    Public HTML/PDF URL, 1–2,000 characters. Supply exactly one source identifier.

  • attachment_id · optional

    string|null

    Authorized uploaded PDF ID, 1–200 characters. Supply exactly one source identifier.

  • read_id · optional

    string|null

    Prior read snapshot ID, 1–200 characters. Requires explicit view.

  • view · optional

    string|null

    focused, find, or full. Omit for legacy bounded full read.

  • focus · optional

    string|null

    Focus text, 1–1,000 characters; required for find and requires explicit view.

  • cursor · optional

    integer

    Non-negative; only valid for find/full. Default 0.

  • purpose · optional

    string

    default, business_contact_info, people, or dom. Default default.

  • include_links · optional

    boolean|null

    Omit to retain legacy HTTP default true; progressive views default false.

  • include_images · optional

    boolean

    Default false.

  • max_age_seconds · optional

    integer|null

    URL-only bound from 600 to 2,592,000 seconds.

  • max_content_chars · optional

    integer

    1,000–300,000; legacy default 80,000. Progressive full windows cap at 40,000.

  • max_raw_html_chars · optional

    integer

    1,000–1,000,000; default 300,000.

  • max_pdf_bytes · optional

    integer

    1,000–25,000,000 bytes; default 10,000,000.

  • max_pdf_pages · optional

    integer

    1–200 pages; default 50.

  • pdf_page_start · optional

    integer

    One-based start page; default 1.

Errors

StatusMeaning
401Authentication is required.
403The caller lacks access to the resource or the search:run scope.
400The request does not satisfy the route or typed request contract.

Docs