Superhuman Docs tools
The 12 Superhuman Docs operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- List docsGETLists the docs the user can access and has opened at least once, latest activity first, with id, name, owner, workspace and browserLink. Send nextPageToken as pageToken for the next page.
- Create docPOSTCreates a doc, empty or as a copy of another doc, in the My docs folder of the oldest workspace the user joined. Needs the Doc Maker role in the workspace.
- List pagesGETLists the pages of a doc with id, name, subtitle, parent and children. Send nextPageToken as pageToken for the next page.
- List page contentGETReturns the content of a page as plain text, element by element. Send nextPageToken as pageToken for the next part.
- Create pagePOSTCreates a page in a doc, or a subpage, with content in Markdown or HTML. The change is queued and shows up in a few seconds; the response has the id of the page. Needs the Doc Maker role.
- Update pagePUTRenames a page or adds content to it, at the end, at the start or replacing everything. The change is queued and shows up in a few seconds. Changing the name needs the Doc Maker role.
- List tablesGETLists the tables and views of a doc with id, name, type and parent page. Rows are written only to tables, not to views. Send nextPageToken as pageToken for the next page.
- List columnsGETLists the columns of a table with id, name and format. The column ids go in the cells of Create rows and Update row and in the query of List rows.
- List rowsGETLists the rows of a table or view, oldest first unless sortBy says otherwise, with id, name and the values keyed by column id. The data can lag a few seconds behind the doc; send nextPageToken as pageToken for the next page.
- Create rowsPOSTInserts rows in a table, or updates the rows that match the keyColumns. Every matching row is updated. Only base tables take rows, not views; the change is queued and shows up in a few seconds.
- Update rowPUTChanges cells of a row. The change is queued and shows up in a few seconds.
- Delete rowDELETEDeletes a row from a table or view. The deletion is queued and done in a few seconds.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
