# HERO API ## Docs - [AI agents overview](https://developers.myhero.so/ai/overview.md) - [Check document access](https://developers.myhero.so/api-reference/access/get-document-access.md): Returns `true` if the authenticated user can access the document identified by `documentId`, `false` otherwise. - [Check email existence](https://developers.myhero.so/api-reference/access/get-email-exists.md): Returns `true` if a user account is registered for `email`, `false` otherwise. - [Check project access](https://developers.myhero.so/api-reference/access/get-project-access.md): Returns `true` if the authenticated user can access the project identified by `projectId`, `false` otherwise. - [Run an AI agent](https://developers.myhero.so/api-reference/ai/ai-chat.md): Runs the general AI agent and returns the complete response as a `chatMessages` array. - [Retrieve AI usage](https://developers.myhero.so/api-reference/ai/ai-get-usage.md): Returns the authenticated user's current token consumption (`usedTokens`), plan limit (`tokenLimit`), and the timestamp when the usage counter resets (`tokenResetAt`). - [Stream an AI agent](https://developers.myhero.so/api-reference/ai/ai-stream.md): Runs the general AI agent and streams its response as Server-Sent Events over `text/event-stream`. - [Transform text](https://developers.myhero.so/api-reference/ai/ai-transform-text.md): Applies a named transformation (`operation`) to the provided `text` and returns the rewritten string along with token `usage`. - [Undo last AI agent run](https://developers.myhero.so/api-reference/ai/ai-undo.md): Reverses the most recent AI-driven changes for the given `sessionId` and truncates that exchange from the conversation history. - [Create an API key](https://developers.myhero.so/api-reference/api-keys/create-api-key.md): Creates a personal API key that authenticates as the calling user against the standard REST API. - [List API keys](https://developers.myhero.so/api-reference/api-keys/list-api-keys.md): Returns the calling user's REST API keys (active only). - [Revoke an API key](https://developers.myhero.so/api-reference/api-keys/revoke-api-key.md): Marks the API key as revoked. - [Retrieve a block](https://developers.myhero.so/api-reference/blocks/get-block-by-id.md): Returns a single block document (clause block, clause reference, placeholder, term definition, or image block) by its `_id`. - [Retrieve multiple blocks](https://developers.myhero.so/api-reference/blocks/get-blocks-by-ids.md): Accepts an array of block IDs and returns the matching block documents. - [Retrieve a clause block](https://developers.myhero.so/api-reference/blocks/get-clause-block-by-id-or-hierarchy.md): Looks up the clause block associated with a clause reference, first by block ID and then by the reference's `hierarchy` string. - [Create a clause reference](https://developers.myhero.so/api-reference/clauses/create-clause-reference.md): Creates a clause reference linking a block in a document to a cross-document clause hierarchy. - [Paste clause references](https://developers.myhero.so/api-reference/clauses/create-pasted-clause-references.md): Duplicates clause references during a paste operation by mapping old reference IDs to new IDs supplied in `oldToNewClauseReferenceIds`. - [Retrieve a clause reference](https://developers.myhero.so/api-reference/clauses/get-clause-reference-by-id.md): Returns the `ClauseReference` record identified by `referenceId`. - [Retrieve multiple clause references](https://developers.myhero.so/api-reference/clauses/get-clause-references-by-ids.md): Bulk-fetches `ClauseReference` records for the IDs supplied in `data`. - [Accept a document transfer](https://developers.myhero.so/api-reference/documents/accept-document-transfer.md): Accepts a pending transfer identified by `transferId`, copying the documents into the caller's target workspace or project. - [Create a document](https://developers.myhero.so/api-reference/documents/create-document.md): Creates a new document inside the given project. - [Create a document transfer](https://developers.myhero.so/api-reference/documents/create-document-transfer.md): Initiates a transfer of one or more documents to another user by `email`. - [Decline a document transfer](https://developers.myhero.so/api-reference/documents/decline-document-transfer.md): Marks a pending transfer as declined. - [Delete documents](https://developers.myhero.so/api-reference/documents/delete-documents-many.md): Soft-deletes the given documents and all of their descendants by setting `isDeleted: true`. - [Retrieve document preview content](https://developers.myhero.so/api-reference/documents/get-doc-preview-content-by-document-id.md): Returns the ProseMirror JSON content of a document, derived from its Y.js collaborative state. - [Retrieve a document](https://developers.myhero.so/api-reference/documents/get-document.md): Retrieves a single document by `documentId`. - [Retrieve document editor data](https://developers.myhero.so/api-reference/documents/get-document-initial-data.md): Returns the aggregated payload required to bootstrap the document editor for `documentId`. - [Retrieve PDF template data](https://developers.myhero.so/api-reference/documents/get-document-pdfdata.md): Retrieves the stored PDF template payload for a document of type `EXTERNAL/PDF`. - [Retrieve document settings](https://developers.myhero.so/api-reference/documents/get-document-settings.md): Returns the settings record for the document identified by `documentId`, including `listTemplateId` and `importedTermsFileId`. - [List document transfers](https://developers.myhero.so/api-reference/documents/get-document-transfers.md): Returns all document transfers where the authenticated user is either the sender or the recipient. - [Retrieve multiple documents](https://developers.myhero.so/api-reference/documents/get-documents.md): Fetches a batch of documents by their `_id`s. - [List documents in a project](https://developers.myhero.so/api-reference/documents/get-documents-by-project-id.md): Lists all documents belonging to `projectId`. - [List interconnected document IDs](https://developers.myhero.so/api-reference/documents/get-documents-interconnection.md): Traverses the document graph starting from the provided `documentIds` and returns all reachable related document IDs. - [Retrieve PDF initial data](https://developers.myhero.so/api-reference/documents/get-pdfinitial-data.md): Returns the table references and referenced rows associated with a PDF document. - [Invite a user to a document](https://developers.myhero.so/api-reference/documents/invite-user-to-document.md): Invites a single user by `email` to a document with the specified `role`. - [Invite users to documents](https://developers.myhero.so/api-reference/documents/invite-users-to-documents.md): Invites one or more users by `emails` to one or more `documentIds` at the specified `role`. - [Copy documents to a location](https://developers.myhero.so/api-reference/documents/paste-documents.md): Creates deep copies of the specified documents (and their children) under a new `parentId`. - [Remove a document collaborator](https://developers.myhero.so/api-reference/documents/remove-collaborator.md): Removes a collaborator by `userId` from a single document and cleans up their access from any parent folder hierarchy if they no longer have access to other documents in those folders. - [Remove a collaborator from documents](https://developers.myhero.so/api-reference/documents/remove-collaborator-from-documents.md): Removes a collaborator by `userId` from multiple documents at once. - [Update a collaborator's role](https://developers.myhero.so/api-reference/documents/update-collaborator-role.md): Changes the role of a collaborator on a single document. - [Update document settings](https://developers.myhero.so/api-reference/documents/update-document-settings.md): Applies a partial settings update to the document identified by `documentId`. - [Update many documents](https://developers.myhero.so/api-reference/documents/update-documents-many.md): Updates metadata (name, parentId, icon, published settings, etc.) for one or more documents in a single call. - [Update a PDF template](https://developers.myhero.so/api-reference/documents/update-pdf-template-document.md): Replaces the `basePdf` and `schemas` for a PDF external document. - [Export to PDF](https://developers.myhero.so/api-reference/export/convert-doc-to-pdf.md): Converts one or more base64-encoded DOCX files to PDF via LibreOffice and returns the results as base64-encoded PDF strings. - [Retrieve export data for documents](https://developers.myhero.so/api-reference/export/get-export-documents-data.md): Assembles full export payloads for the requested `documentIds` within a project. - [Begin OAuth authorization](https://developers.myhero.so/api-reference/integrations/begin-authorize.md): Initiates the OAuth authorization flow for the specified `provider` (e.g. `gmail`, `google_drive`). - [Disconnect an integration](https://developers.myhero.so/api-reference/integrations/disconnect-integration.md): Revokes and removes the OAuth connection for the specified `provider` from the authenticated user's account. - [Handle OAuth callback](https://developers.myhero.so/api-reference/integrations/handle-integration-callback.md): Receives the OAuth authorization callback from the provider, exchanges the `code` and `state` for tokens, and responds with an HTML bounce page that JS-redirects the user back to the web or desktop app. - [List connected integrations](https://developers.myhero.so/api-reference/integrations/list-integrations.md): Returns all OAuth integration connections for the authenticated user. - [Download Claude Desktop extension](https://developers.myhero.so/api-reference/mcp/mcp-download-claude-desktop-extension.md): Downloads the HERO Claude Desktop Extension package (`hero.dxt`) as an `application/zip` binary. - [Terminate an MCP session](https://developers.myhero.so/api-reference/mcp/mcp-http-delete.md): Terminates the active MCP session identified by the required `mcp-session-id` header, freeing server-side resources. - [Open an MCP server-sent event stream](https://developers.myhero.so/api-reference/mcp/mcp-http-get.md): Opens a server-sent event stream for an existing MCP session identified by the required `mcp-session-id` header. - [Send a JSON-RPC request to the MCP server](https://developers.myhero.so/api-reference/mcp/mcp-http-post.md): Implements the MCP Streamable HTTP transport (spec 2025-03-26). - [Redirect to MCP install deeplink](https://developers.myhero.so/api-reference/mcp/mcp-install-client.md): Issues a 302 redirect to the client-specific deeplink URL for installing the HERO MCP server (e.g. `cursor`, `vscode`). - [Invoke an MCP tool](https://developers.myhero.so/api-reference/mcp/mcp-invoke-tool.md): Executes the MCP tool identified by `toolName` with the key-value `args` map provided in the request body. - [List MCP tools](https://developers.myhero.so/api-reference/mcp/mcp-list-tools.md): Returns the catalog of MCP tools available to the authenticated user along with system `instructions`. - [Connect via legacy SSE transport](https://developers.myhero.so/api-reference/mcp/mcp-sse-connect.md): Opens a server-sent event stream using the legacy MCP SSE transport. - [Post a message to a legacy SSE session](https://developers.myhero.so/api-reference/mcp/mcp-sse-message.md): Delivers a JSON-RPC message to an active legacy SSE session identified by the `sessionId` query parameter. - [Upload an image](https://developers.myhero.so/api-reference/media/create-image.md): Uploads an image asset and stores its metadata. - [Delete an image](https://developers.myhero.so/api-reference/media/delete-image.md): Deletes the image record identified by `imageId` and removes it from object storage. - [Retrieve image URL](https://developers.myhero.so/api-reference/media/get-image-by-id.md): Returns a signed Supabase URL for the image identified by `imageId`. - [Replace image content](https://developers.myhero.so/api-reference/media/update-image.md): Replaces the binary content of an existing image in object storage and refreshes its signed URL. - [List organizations](https://developers.myhero.so/api-reference/organizations/get-all-organizations.md): Returns all organizations the authenticated user is a member of, including personal and shared organizations. - [Retrieve an organization](https://developers.myhero.so/api-reference/organizations/get-organization-by-id.md): Returns the full organization document for `orgId`. - [Retrieve default organization](https://developers.myhero.so/api-reference/organizations/get-user-default-organization.md): Returns the authenticated user's personal (default) organization, or `null` if none has been created yet. - [Copy projects to a location](https://developers.myhero.so/api-reference/projects/create-pasted-projects.md): Creates deep copies of one or more projects (and all their documents) into the target workspace or project. - [Create a project](https://developers.myhero.so/api-reference/projects/create-project.md): Creates a new project inside the specified workspace. - [Delete projects](https://developers.myhero.so/api-reference/projects/delete-many-projects.md): Soft-deletes multiple projects supplied as a comma-separated list of IDs in the path. - [Delete a project](https://developers.myhero.so/api-reference/projects/delete-project.md): Soft-deletes a project by setting `isDeleted: true` and asynchronously cleans up its inner data. - [Retrieve project initial data](https://developers.myhero.so/api-reference/projects/get-project-initial-data.md): Returns the full aggregated payload needed to initialize the project view, including documents, tables, rows, columns, cells, and blocks for `projectId`. - [Retrieve project tree data](https://developers.myhero.so/api-reference/projects/get-project-tree-data.md): Returns the project metadata and its flat list of documents in a single response. - [List projects in a workspace](https://developers.myhero.so/api-reference/projects/get-projects-in-workspace.md): Returns all projects the caller has access to within the given `workspaceId`. - [Retrieve a project](https://developers.myhero.so/api-reference/projects/get-single-project.md): Retrieves a single project by `projectId`. - [Update a project](https://developers.myhero.so/api-reference/projects/update-project.md): Updates one or more metadata fields (`name`, `description`, `reference`, `icon`, `emoji`) for the given project. - [Authenticate to a published doc](https://developers.myhero.so/api-reference/published/authenticate-published-document.md): Validates a viewer's password against a password-protected published portal. - [Retrieve published dashboard info](https://developers.myhero.so/api-reference/published/get-published-dashboard-info.md): Returns the list of published documents, their publishers' profiles, project branding, and configured published domains for `projectId`. - [Retrieve a published document](https://developers.myhero.so/api-reference/published/get-published-document-data.md): Returns the ProseMirror content and metadata for a single published document identified by `publishedId`. - [List published domains](https://developers.myhero.so/api-reference/published/get-published-domains.md): Returns the project document with its `published` domain array for `projectId`. - [Retrieve published homepage ID](https://developers.myhero.so/api-reference/published/get-published-homepage.md): Resolves the portal slug from the request and returns the `homepageId` of its first published domain. 404 when the portal has no homepage configured. - [Retrieve a published media file](https://developers.myhero.so/api-reference/published/get-published-media.md): Streams the raw image bytes for `imageId` attached to the published document `publishedId`. - [Retrieve published project branding](https://developers.myhero.so/api-reference/published/get-published-project-branding.md): Returns the `company` and `callToAction` branding for the project that owns the given `projectId` (or the slug-resolved portal when `projectId` is `home`). - [Retrieve published project data](https://developers.myhero.so/api-reference/published/get-published-project-initial-data.md): Returns the project-level aggregate data (`projectData`) for the portal that owns the given `publishedId`. - [Retrieve a published tooltip](https://developers.myhero.so/api-reference/published/get-published-tooltip.md): Returns the title and ProseMirror content for a term-definition or clause-reference block identified by `tooltipId`. - [Publish or unpublish documents](https://developers.myhero.so/api-reference/published/publish-documents.md): Sets `isPublished` on each document in `documentIds` and returns the updated publish settings. - [Update published branding](https://developers.myhero.so/api-reference/published/update-published-branding.md): Updates the company info and call-to-action branding stored on a project's published portal. - [Update published document settings](https://developers.myhero.so/api-reference/published/update-published-doc-settings.md): Persists per-document published settings — custom styling key/value pairs and the `domainSlug` — for the document identified by `publishedId`. - [Update a published domain](https://developers.myhero.so/api-reference/published/update-published-domain.md): Updates the slug, password, disabled state, or homepage document for the domain identified by `slug`. - [List referenced rows for a document](https://developers.myhero.so/api-reference/references/get-referenced-rows-by-document-id.md): Returns all `ReferencedRowInDocument` records associated with the specified `documentId`. - [Retrieve referenced rows by IDs](https://developers.myhero.so/api-reference/references/get-referenced-rows-in-document-by-ids.md): Bulk-fetches `ReferencedRowInDocument` records for the IDs supplied in `data`. - [Update a referenced row ID](https://developers.myhero.so/api-reference/references/update-referenced-row-in-document.md): Updates the `rowId` on an existing `ReferencedRowInDocument` record identified by the `tableId` + `documentId` + `workspaceId` combination. - [Upsert a referenced row](https://developers.myhero.so/api-reference/references/upsert-referenced-row-in-document.md): Creates or updates a record linking a table row to a document. - [Add a snapshot comment](https://developers.myhero.so/api-reference/snapshots/add-snapshot-comment.md): Appends a new comment to the snapshot's `comments` array. - [Create a snapshot](https://developers.myhero.so/api-reference/snapshots/create-snapshot.md): Captures the current Y.js state of a document as a restorable snapshot. - [Delete a snapshot](https://developers.myhero.so/api-reference/snapshots/delete-snapshot.md): Permanently deletes the snapshot. - [Delete a snapshot comment](https://developers.myhero.so/api-reference/snapshots/delete-snapshot-comment.md): Removes a comment from a snapshot. - [Update a snapshot comment](https://developers.myhero.so/api-reference/snapshots/edit-snapshot-comment.md): Replaces the text of a snapshot comment. - [Retrieve a snapshot](https://developers.myhero.so/api-reference/snapshots/get-snapshot-by-id.md): Returns a single snapshot including the full Y.js-encoded `state` binary, suitable for rendering or restoring the document at that point in time. - [List snapshots for a document](https://developers.myhero.so/api-reference/snapshots/get-snapshots-by-document-id.md): Returns all snapshots for the given document, sorted newest-first. - [Rename a snapshot](https://developers.myhero.so/api-reference/snapshots/update-snapshot-name.md): Sets a new `name` for the snapshot. - [Update a snapshot](https://developers.myhero.so/api-reference/snapshots/update-snapshot-partial.md): Updates a snapshot's `name`, `description`, or both. - [Create a column](https://developers.myhero.so/api-reference/tables/create-column.md): Adds a new typed column to the given table and creates blank cells for every existing row. - [Duplicate pasted table references](https://developers.myhero.so/api-reference/tables/create-pasted-table-references.md): Re-creates table references for a document block that was pasted into `documentId`. - [Create a row](https://developers.myhero.so/api-reference/tables/create-row.md): Appends a new row to the given table and creates blank cells for every existing column. - [Create a table](https://developers.myhero.so/api-reference/tables/create-table.md): Creates a new table inside the given project. - [Create tables from a spreadsheet](https://developers.myhero.so/api-reference/tables/create-table-from-csv.md): Parses a CSV, TSV, or XLSX file (provided as a base64-encoded string in `csvData`) and creates one table per sheet. - [Create a table reference](https://developers.myhero.so/api-reference/tables/create-table-reference.md): Links a table column into a document, optionally binding it to a specific row. - [Delete a column](https://developers.myhero.so/api-reference/tables/delete-column.md): Permanently deletes a column and all its cells. - [Delete a row](https://developers.myhero.so/api-reference/tables/delete-row.md): Permanently deletes a row and all its cells. - [Delete a table](https://developers.myhero.so/api-reference/tables/delete-table.md): Permanently deletes the table and all its associated rows, columns, and cells. - [List tables in a project](https://developers.myhero.so/api-reference/tables/get-all-tables-by-project-id.md): Returns all table documents the authenticated user can access within the given project. - [List table IDs in a project](https://developers.myhero.so/api-reference/tables/get-all-tables-ids-by-project-id.md): Returns the `_id` of every table in the given project, ordered newest-first. - [Retrieve multiple cells](https://developers.myhero.so/api-reference/tables/get-cells-by-ids.md): Accepts an array of cell IDs and returns the subset the caller can access. - [Retrieve multiple columns](https://developers.myhero.so/api-reference/tables/get-columns-by-ids.md): Accepts an array of column IDs and returns the subset belonging to tables the caller can access. - [List cells in a row](https://developers.myhero.so/api-reference/tables/get-row-cells.md): Returns all cells belonging to a specific row. - [Retrieve row permissions](https://developers.myhero.so/api-reference/tables/get-row-permissions.md): Returns the caller's highest effective role for the given row and a `canEdit` flag indicating whether the user may write to cells in that row. - [Retrieve multiple rows](https://developers.myhero.so/api-reference/tables/get-rows-by-ids.md): Accepts an array of row IDs and returns the subset the caller can access. - [Retrieve a table](https://developers.myhero.so/api-reference/tables/get-table-by-id.md): Returns a single table document. - [Retrieve a cell](https://developers.myhero.so/api-reference/tables/get-table-cell.md): Returns a single cell document including its typed `data` value. - [List cells in a table](https://developers.myhero.so/api-reference/tables/get-table-cells.md): Returns all cells for the given table that the caller can access. - [Retrieve a column](https://developers.myhero.so/api-reference/tables/get-table-column.md): Returns a single column document including its data type and type-specific options. - [List columns in a table](https://developers.myhero.so/api-reference/tables/get-table-columns.md): Returns all column documents for the given table, including their types and type-specific options. - [Retrieve table permissions](https://developers.myhero.so/api-reference/tables/get-table-permissions.md): Returns the caller's highest effective role (`owner`, `admin`, `member`, `editor`, or `viewer`) for the given table, together with whether access is granted via workspace membership and the list of referencing document IDs. - [Retrieve a table reference](https://developers.myhero.so/api-reference/tables/get-table-reference-by-id.md): Returns a single table reference document. - [List table references in a document](https://developers.myhero.so/api-reference/tables/get-table-references-by-document-id.md): Returns all table references embedded in the given document. - [Retrieve multiple table references](https://developers.myhero.so/api-reference/tables/get-table-references-by-ids.md): Accepts an array of table reference IDs and returns matching documents. - [Retrieve a row](https://developers.myhero.so/api-reference/tables/get-table-row.md): Returns a single row document. - [List rows in a table](https://developers.myhero.so/api-reference/tables/get-table-rows.md): Returns all rows the caller can access within the given table. - [Retrieve multiple tables](https://developers.myhero.so/api-reference/tables/get-tables-by-ids.md): Accepts an array of table IDs and returns the subset the caller can access. - [Update a cell](https://developers.myhero.so/api-reference/tables/update-cell.md): Updates the `value` of a single cell. - [Update a column](https://developers.myhero.so/api-reference/tables/update-column.md): Updates a column's `name`, `description`, data `type`, or type-specific options (`number`, `oneMany`, `selectItems`). - [Update a table](https://developers.myhero.so/api-reference/tables/update-table.md): Updates a table's `name`, `description`, `columns` order array, or `icon`. - [Update a table reference](https://developers.myhero.so/api-reference/tables/update-table-reference.md): Updates the `oneToManyColumnId` and/or `oneToManyInstanceIds` of a table reference. - [Copy document templates to a project](https://developers.myhero.so/api-reference/templates/copy-template-documents-to-user.md): Copies up to 10 document templates into a user's project, refreshing all internal IDs in the process. - [Copy project templates to a workspace](https://developers.myhero.so/api-reference/templates/copy-template-projects-to-user.md): Copies one or more project templates into the specified workspace, creating new projects for each. - [Import SEC EDGAR filings as templates](https://developers.myhero.so/api-reference/templates/create-sec-gov-documents.md): Fetches and parses SEC EDGAR `.htm` filing URLs, converts them to Scribe document format, and stores them as document templates. - [List all templates](https://developers.myhero.so/api-reference/templates/get-all-templates.md): Returns all available project templates and document templates in a single response. - [List document templates](https://developers.myhero.so/api-reference/templates/get-document-templates.md): Returns all available document templates. - [List project templates](https://developers.myhero.so/api-reference/templates/get-project-templates.md): Returns all available project templates including their name, icon, emoji, and metadata. - [Retrieve clause tooltip](https://developers.myhero.so/api-reference/tooltips/get-tooltip-clause-reference.md): Returns the tooltip content for a clause reference, including the referenced block's `title`, ProseMirror `content` nodes, and `blockId`. - [Retrieve term tooltip](https://developers.myhero.so/api-reference/tooltips/get-tooltip-term.md): Returns the tooltip content for a term definition identified by `termId`, including a `title` and ProseMirror `content` array. - [List TTS voices](https://developers.myhero.so/api-reference/tts/get-tts-voices.md): Returns the catalog of available text-to-speech voices, each with a `key`, display `name`, and `gender` (`female` | `male`). - [Synthesize conversational speech](https://developers.myhero.so/api-reference/tts/synthesize-conversational.md): Generates text-to-speech audio in a conversational style and returns the result as a binary `audio/mpeg` stream. - [Synthesize speech](https://developers.myhero.so/api-reference/tts/synthesize-speech.md): Generates text-to-speech audio for the given `text` using the configured Gemini TTS provider. - [Create documents from a file tree](https://developers.myhero.so/api-reference/upload/create-uploaded-documents.md): Ingests a nested file-tree map of base64-encoded file contents (`uploaded`) and creates corresponding Scribe documents in the specified workspace or project. - [Validate an embed URL](https://developers.myhero.so/api-reference/upload/validate-embed-url.md): Checks whether the given `url` is safe and suitable for embedding in the editor. - [Create a user account](https://developers.myhero.so/api-reference/users/create-user.md): Creates a new Firebase and database user record from the provided `email` and `password`. - [Retrieve entity owner](https://developers.myhero.so/api-reference/users/get-doc-owner.md): Returns the `CollaboratorUser` who owns the document, project, or workspace identified by `docId`. - [Retrieve own user profile](https://developers.myhero.so/api-reference/users/get-self-user-info.md): Returns the full user document for the authenticated caller, including profile fields and editor settings such as font size, theme, tree ordering, and signature preferences. - [List collaborators](https://developers.myhero.so/api-reference/users/get-user-collaborators.md): Returns all users who share at least one organization or workspace with the authenticated user. - [Retrieve collaborators by IDs or emails](https://developers.myhero.so/api-reference/users/get-user-collaborators-by-ids.md): Looks up users by comma-separated `userIds` and/or `emails` query params and returns the matching `CollaboratorUser` records. - [Complete user onboarding](https://developers.myhero.so/api-reference/users/setup-user-default-data.md): Finalizes account setup for a newly registered user: creates a default organization and workspace, provisions a Stripe customer and billing seat, applies any early-bird coupon, and optionally seeds template projects and sends invitation emails. - [Update user profile](https://developers.myhero.so/api-reference/users/update-user-info.md): Updates one or more profile fields (`firstName`, `lastName`, `pictureUrl`, `avatarId`) for the authenticated user. - [Update user settings](https://developers.myhero.so/api-reference/users/update-user-settings.md): Persists editor and display preferences — font size, theme, tree ordering, selected signature, or custom signature — for the authenticated user. - [Update a collaborator's workspace role](https://developers.myhero.so/api-reference/workspaces/change-workspace-user-role.md): Changes the role of a workspace collaborator identified by `userId`. - [Create a workspace](https://developers.myhero.so/api-reference/workspaces/create-workspace.md): Creates a new workspace under the authenticated user's default organization. - [Delete a workspace](https://developers.myhero.so/api-reference/workspaces/delete-workspace.md): Soft-deletes the workspace and all of its projects. - [List workspaces](https://developers.myhero.so/api-reference/workspaces/get-all-user-workspaces.md): Returns all workspaces the authenticated user is a member of, across all organizations. - [List workspaces in an organization](https://developers.myhero.so/api-reference/workspaces/get-all-user-workspaces-by-org-id.md): Returns all workspaces the authenticated user belongs to within the specified `orgId`. - [Retrieve the default workspace](https://developers.myhero.so/api-reference/workspaces/get-default-workspace.md): Returns the default workspace for the authenticated user's default organization. - [Retrieve a workspace](https://developers.myhero.so/api-reference/workspaces/get-workspace-by-id.md): Retrieves a single workspace by `workspaceId`. - [Retrieve workspace dashboard info](https://developers.myhero.so/api-reference/workspaces/get-workspace-dashboard-info.md): Returns aggregated information for the workspace dashboard, including the workspace record, member profiles, and teams. - [Invite a user to a workspace](https://developers.myhero.so/api-reference/workspaces/invite-user-to-workspace.md): Sends a workspace invitation to the given `email` address at the specified `role`. - [Leave a workspace](https://developers.myhero.so/api-reference/workspaces/remove-self-from-workspace.md): Removes the authenticated user from the workspace. - [Remove a user from a workspace](https://developers.myhero.so/api-reference/workspaces/remove-user-from-workspace.md): Removes a collaborator from the workspace. - [Update a workspace](https://developers.myhero.so/api-reference/workspaces/update-workspace.md): Updates the `name` and/or `description` of a workspace. - [Authentication](https://developers.myhero.so/authentication.md) - [Changelog](https://developers.myhero.so/changelog.md): Updates to the HERO API. - [Errors](https://developers.myhero.so/errors.md) - [Overview](https://developers.myhero.so/introduction.md): Build with documents, projects, tables, and AI. - [OAuth flow for MCP](https://developers.myhero.so/mcp/oauth.md) - [Connect HERO to your AI tool](https://developers.myhero.so/mcp/overview.md) - [Personal access tokens](https://developers.myhero.so/mcp/tokens.md) - [Append markdown to document](https://developers.myhero.so/mcp/tools/editor/append-markdown-to-document.md) - [Create document snapshot](https://developers.myhero.so/mcp/tools/editor/create-document-snapshot.md) - [List document blocks](https://developers.myhero.so/mcp/tools/editor/list-document-blocks.md) - [Patch document](https://developers.myhero.so/mcp/tools/editor/patch-document.md) - [Read document content](https://developers.myhero.so/mcp/tools/editor/read-document-content.md) - [Write document markdown](https://developers.myhero.so/mcp/tools/editor/write-document-markdown.md) - [Get hero writing guide](https://developers.myhero.so/mcp/tools/general/get-hero-writing-guide.md) - [Tool catalog](https://developers.myhero.so/mcp/tools/index.md) - [Dropbox get file content](https://developers.myhero.so/mcp/tools/integrations-dropbox/dropbox-get-file-content.md) - [Dropbox list folder](https://developers.myhero.so/mcp/tools/integrations-dropbox/dropbox-list-folder.md) - [Dropbox search](https://developers.myhero.so/mcp/tools/integrations-dropbox/dropbox-search.md) - [Gmail get attachment](https://developers.myhero.so/mcp/tools/integrations-gmail/gmail-get-attachment.md) - [Gmail get message](https://developers.myhero.so/mcp/tools/integrations-gmail/gmail-get-message.md) - [Gmail get thread](https://developers.myhero.so/mcp/tools/integrations-gmail/gmail-get-thread.md) - [Gmail search](https://developers.myhero.so/mcp/tools/integrations-gmail/gmail-search.md) - [Drive get file content](https://developers.myhero.so/mcp/tools/integrations-google-drive/drive-get-file-content.md) - [Drive list folder](https://developers.myhero.so/mcp/tools/integrations-google-drive/drive-list-folder.md) - [Drive search](https://developers.myhero.so/mcp/tools/integrations-google-drive/drive-search.md) - [Notion get page](https://developers.myhero.so/mcp/tools/integrations-notion/notion-get-page.md) - [Notion query database](https://developers.myhero.so/mcp/tools/integrations-notion/notion-query-database.md) - [Notion search](https://developers.myhero.so/mcp/tools/integrations-notion/notion-search.md) - [Onedrive get file content](https://developers.myhero.so/mcp/tools/integrations-onedrive/onedrive-get-file-content.md) - [Onedrive list folder](https://developers.myhero.so/mcp/tools/integrations-onedrive/onedrive-list-folder.md) - [Onedrive search](https://developers.myhero.so/mcp/tools/integrations-onedrive/onedrive-search.md) - [Outlook get attachment](https://developers.myhero.so/mcp/tools/integrations-outlook/outlook-get-attachment.md) - [Outlook get conversation](https://developers.myhero.so/mcp/tools/integrations-outlook/outlook-get-conversation.md) - [Outlook get message](https://developers.myhero.so/mcp/tools/integrations-outlook/outlook-get-message.md) - [Outlook search](https://developers.myhero.so/mcp/tools/integrations-outlook/outlook-search.md) - [Build document map](https://developers.myhero.so/mcp/tools/knowledge/build-document-map.md) - [Create clause reference](https://developers.myhero.so/mcp/tools/knowledge/create-clause-reference.md) - [Explain term definition](https://developers.myhero.so/mcp/tools/knowledge/explain-term-definition.md) - [Find documents with clause blocks](https://developers.myhero.so/mcp/tools/knowledge/find-documents-with-clause-blocks.md) - [Get document clauses](https://developers.myhero.so/mcp/tools/knowledge/get-document-clauses.md) - [Get document maps](https://developers.myhero.so/mcp/tools/knowledge/get-document-maps.md) - [Get document metadata](https://developers.myhero.so/mcp/tools/knowledge/get-document-metadata.md) - [Get section by numbering](https://developers.myhero.so/mcp/tools/knowledge/get-section-by-numbering.md) - [Get section titles](https://developers.myhero.so/mcp/tools/knowledge/get-section-titles.md) - [Get table schema](https://developers.myhero.so/mcp/tools/knowledge/get-table-schema.md) - [List clause blocks for reference](https://developers.myhero.so/mcp/tools/knowledge/list-clause-blocks-for-reference.md) - [List project documents](https://developers.myhero.so/mcp/tools/knowledge/list-project-documents.md) - [List project folders](https://developers.myhero.so/mcp/tools/knowledge/list-project-folders.md) - [Read document text](https://developers.myhero.so/mcp/tools/knowledge/read-document-text.md) - [Resolve table by name](https://developers.myhero.so/mcp/tools/knowledge/resolve-table-by-name.md) - [Lookup table columns](https://developers.myhero.so/mcp/tools/placeholders/lookup-table-columns.md) - [Lookup table rows](https://developers.myhero.so/mcp/tools/placeholders/lookup-table-rows.md) - [Prepare placeholder references](https://developers.myhero.so/mcp/tools/placeholders/prepare-placeholder-references.md) - [Update referenced row](https://developers.myhero.so/mcp/tools/placeholders/update-referenced-row.md) - [Copy documents to](https://developers.myhero.so/mcp/tools/project-tree/copy-documents-to.md) - [Create document](https://developers.myhero.so/mcp/tools/project-tree/create-document.md) - [Create document batch](https://developers.myhero.so/mcp/tools/project-tree/create-document-batch.md) - [Create project](https://developers.myhero.so/mcp/tools/project-tree/create-project.md) - [Delete documents](https://developers.myhero.so/mcp/tools/project-tree/delete-documents.md) - [Delete project](https://developers.myhero.so/mcp/tools/project-tree/delete-project.md) - [Duplicate documents](https://developers.myhero.so/mcp/tools/project-tree/duplicate-documents.md) - [List project tree](https://developers.myhero.so/mcp/tools/project-tree/list-project-tree.md) - [List user workspaces](https://developers.myhero.so/mcp/tools/project-tree/list-user-workspaces.md) - [List workspace projects](https://developers.myhero.so/mcp/tools/project-tree/list-workspace-projects.md) - [Move document](https://developers.myhero.so/mcp/tools/project-tree/move-document.md) - [Move document batch](https://developers.myhero.so/mcp/tools/project-tree/move-document-batch.md) - [Rename document](https://developers.myhero.so/mcp/tools/project-tree/rename-document.md) - [Rename project](https://developers.myhero.so/mcp/tools/project-tree/rename-project.md) - [Search documents](https://developers.myhero.so/mcp/tools/project-tree/search-documents.md) - [Update documents meta batch](https://developers.myhero.so/mcp/tools/project-tree/update-documents-meta-batch.md) - [Add row](https://developers.myhero.so/mcp/tools/tables-data/add-row.md) - [Add row batch](https://developers.myhero.so/mcp/tools/tables-data/add-row-batch.md) - [Batch update column](https://developers.myhero.so/mcp/tools/tables-data/batch-update-column.md) - [Delete row](https://developers.myhero.so/mcp/tools/tables-data/delete-row.md) - [Lookup table cells](https://developers.myhero.so/mcp/tools/tables-data/lookup-table-cells.md) - [Update cells](https://developers.myhero.so/mcp/tools/tables-data/update-cells.md) - [Create table reference](https://developers.myhero.so/mcp/tools/tables-references/create-table-reference.md) - [Get document table references](https://developers.myhero.so/mcp/tools/tables-references/get-document-table-references.md) - [Set formula](https://developers.myhero.so/mcp/tools/tables-references/set-formula.md) - [Add column](https://developers.myhero.so/mcp/tools/tables-schema/add-column.md) - [Create table](https://developers.myhero.so/mcp/tools/tables-schema/create-table.md) - [Delete column](https://developers.myhero.so/mcp/tools/tables-schema/delete-column.md) - [Delete table](https://developers.myhero.so/mcp/tools/tables-schema/delete-table.md) - [Get table data](https://developers.myhero.so/mcp/tools/tables-schema/get-table-data.md) - [List project tables](https://developers.myhero.so/mcp/tools/tables-schema/list-project-tables.md) - [Rename table](https://developers.myhero.so/mcp/tools/tables-schema/rename-table.md) - [Update column](https://developers.myhero.so/mcp/tools/tables-schema/update-column.md) - [Fetch url content](https://developers.myhero.so/mcp/tools/web/fetch-url-content.md) - [Search web](https://developers.myhero.so/mcp/tools/web/search-web.md) - [Web cache get meta](https://developers.myhero.so/mcp/tools/web/web-cache-get-meta.md) - [Web cache read chunk](https://developers.myhero.so/mcp/tools/web/web-cache-read-chunk.md) - [Web cache read tail](https://developers.myhero.so/mcp/tools/web/web-cache-read-tail.md) - [Finish with summary](https://developers.myhero.so/mcp/tools/workflows/finish-with-summary.md) - [Plan](https://developers.myhero.so/mcp/tools/workflows/plan.md) - [Realtime collaboration](https://developers.myhero.so/realtime-collaboration.md) - [Webhooks](https://developers.myhero.so/webhooks.md) - [Working with the API](https://developers.myhero.so/working-with-the-api.md): Conventions, base URL, and your first request. ## OpenAPI Specs - [openapi](https://developers.myhero.so/openapi.json)