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· optionalstring|null
Public HTML/PDF URL, 1–2,000 characters. Supply exactly one source identifier.
attachment_id· optionalstring|null
Authorized uploaded PDF ID, 1–200 characters. Supply exactly one source identifier.
read_id· optionalstring|null
Prior read snapshot ID, 1–200 characters. Requires explicit view.
view· optionalstring|null
focused, find, or full. Omit for legacy bounded full read.
focus· optionalstring|null
Focus text, 1–1,000 characters; required for find and requires explicit view.
cursor· optionalinteger
Non-negative; only valid for find/full. Default 0.
purpose· optionalstring
default, business_contact_info, people, or dom. Default default.
include_links· optionalboolean|null
Omit to retain legacy HTTP default true; progressive views default false.
include_images· optionalboolean
Default false.
max_age_seconds· optionalinteger|null
URL-only bound from 600 to 2,592,000 seconds.
max_content_chars· optionalinteger
1,000–300,000; legacy default 80,000. Progressive full windows cap at 40,000.
max_raw_html_chars· optionalinteger
1,000–1,000,000; default 300,000.
max_pdf_bytes· optionalinteger
1,000–25,000,000 bytes; default 10,000,000.
max_pdf_pages· optionalinteger
1–200 pages; default 50.
pdf_page_start· optionalinteger
One-based start page; default 1.
| Name | Type | Description |
|---|---|---|
| url | string|null | Public HTML/PDF URL, 1–2,000 characters. Supply exactly one source identifier. |
| attachment_id | string|null | Authorized uploaded PDF ID, 1–200 characters. Supply exactly one source identifier. |
| read_id | string|null | Prior read snapshot ID, 1–200 characters. Requires explicit view. |
| view | string|null | focused, find, or full. Omit for legacy bounded full read. |
| focus | string|null | Focus text, 1–1,000 characters; required for find and requires explicit view. |
| cursor | integer | Non-negative; only valid for find/full. Default 0. |
| purpose | string | default, business_contact_info, people, or dom. Default default. |
| include_links | boolean|null | Omit to retain legacy HTTP default true; progressive views default false. |
| include_images | boolean | Default false. |
| max_age_seconds | integer|null | URL-only bound from 600 to 2,592,000 seconds. |
| max_content_chars | integer | 1,000–300,000; legacy default 80,000. Progressive full windows cap at 40,000. |
| max_raw_html_chars | integer | 1,000–1,000,000; default 300,000. |
| max_pdf_bytes | integer | 1,000–25,000,000 bytes; default 10,000,000. |
| max_pdf_pages | integer | 1–200 pages; default 50. |
| pdf_page_start | integer | One-based start page; default 1. |
Errors
| Status | Meaning |
|---|---|
| 401 | Authentication is required. |
| 403 | The caller lacks access to the resource or the search:run scope. |
| 400 | The request does not satisfy the route or typed request contract. |
