Read a page
read_pageRead one page back out of the vault, by the documentId an earlier call returned or by the externalId it was filed under. Returns the page as Markdown, which is what to change and send back when editing it, along with its title and its links.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project | No | The repository or project this artifact belongs to, such as the repository's name. Send the same one every time. A key is unique within its project, and a new page is filed in the project's own folder. Leave it out only for work that belongs to no project. | |
| documentId | No | The page's id. | |
| externalId | No | The key the page was filed under. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Where the owner reads it, signed in. | |
| icon | No | The emoji beside the title. | |
| text | Yes | The same page as plain text. | |
| cover | No | The banner across the top of the page, by name. "uploaded" when it is a picture the owner put there. | |
| title | Yes | ||
| access | No | Who can open the shareable link: anyone who has it, or only somebody who also has the passcode. | |
| project | No | The project the key is filed under, lowercased. | |
| markdown | Yes | The page as Markdown. Edit this and send it back, or match against it with edit_page. | |
| passcode | No | The passcode the link needs, when access is passcode. Give it to the user exactly as written, alongside the link. | |
| createdAt | No | ||
| publicUrl | No | The shareable link, when the page is published. | |
| updatedAt | No | ||
| documentId | Yes | ||
| externalId | No | ||
| isPublished | Yes | ||
| markdownWarnings | No | Parts of the page Markdown cannot carry, which a write would drop. |