odp_download_document
Retrieve and read one USPTO patent application file-wrapper document, such as an office action, remarks, or claims, as plain text or PDF by application and document ID.
Instructions
Read one file-wrapper document, as plain text or as a PDF.
USE THIS TOOL WHEN: odp_get_documents or odp_search_office_actions
gave you a document identifier and you need to read the office
action, applicant's remarks (REM), claims (CLM), notice of allowance,
petition decision or other paper itself.
Prefer format="text": it returns the paper's body as plain text (an
office action is typically 10-20k characters) from the XML USPTO
publishes with the document. Claim amendments keep their markup,
deletions as ~~text~~ and insertions as ++text++. Applicant papers
are OCR text and can carry OCR errors. Documents listed with an
"XML" format have text; others (older papers, drawings) return
NO_TEXT_AVAILABLE, and format="pdf" still works for them.
Args:
app_num: Application number without slashes (e.g., "16123456")
document_id: documentIdentifier from odp_get_documents, or
document_id from odp_search_office_actions
(e.g., "K87AK41FRXEAPX5")
format: "text" (plain text) or "pdf" (base64 PDF, the default)
text_offset: With format="text", the character to start from.
Long papers come back in 24k-character pages; pass the
previous response's next_offset to continue.
Returns:
format="text": {"success": True, "text", "total_chars",
"text_offset", "next_offset" (None when done), "source_file"}.
format="pdf": {"success": True, "filename", "content_type",
"size_bytes", "content"} with the PDF as base64. Documents over
4 MB are refused with RESPONSE_TOO_LARGE. Requires USPTO_API_KEY.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| format | No | ||
| app_num | Yes | ||
| document_id | Yes | ||
| text_offset | No |