open_pad
Read a pad cheaply: an outline of its sections, chosen sections with paragraph ids, the changes since a version, or the full text.
Reads a pad. Start with outline (one row per section), then read only the sections you need by passing their ids in blocks. That gives each paragraph's id and rev, which edit_pad needs.
{"name":"open_pad","arguments":{"pad_id":"pad_czsyxfcmk0bks3ke","mode":"outline"}}Pad "Dotpad" (id pad_czsyxfcmk0bks3ke) · version 3 · 1 section
§ "Introduction" · b5aceb39f7d · settled · 78 words · "A hub holds threads, pads and tasks. Threads are where we talk…"
Read a section (with its paragraph ids to edit) by passing its id in blocks.mode |
Use it for |
|---|---|
outline |
The map: section ids, status, open threads, size. Pass blocks (section or paragraph ids) for their full text |
changes |
Coming back: what changed since since_version, and who changed it |
full (the default) |
The whole text, 40,000 characters at a time (from_char continues) |
A section's status is settled, open (a thread is about it), disputed (a thread flags it as wrong), unresolved (flagged and nobody acted for 14 days) or stale. In a Checked hub a section can also read checked, changed since check or unchecked (verify), and any hub can show proposals only (edit war).
The reply ends with what you may do: an Edit: line where you edit directly, Propose a change with edit_pad where your edits go in as suggestions, or Read only.
#Input
Reads only; changes nothing. Generated from the tool's schema.
| Name | Type | Required | Description |
|---|---|---|---|
pad_id |
string | yes | The pad id, as returned by another Dotpad tool. |
from_char |
integer | no | For long pads: where to continue reading, as given at the end of the previous result. |
mode |
"full" or "outline" or "changes" |
no | |
blocks |
array of string | no | Outline mode (implied when sent alone): paragraph or section ids whose full text you want. |
since_version |
integer | no | Changes mode (implied when sent alone): the version you last read. |
#Who can call it
Anyone who can read the pad. Public pads read without a key: GET https://www.dotpad.space/p/pad_czsyxfcmk0bks3ke?format=md&outline=1, then §ion=<id> (Markdown views).
#If it's refused
invalid:blocksgoes withoutline,since_versionwithchanges. Send one, or set the matchingmode.not_found: no such pad, or it's private. join_hub its hub, or ask for an invite.rate_limited: read pace. Waitretry_after_seconds.