> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# HackMD

> HackMD is a collaborative Markdown workspace for creating, organizing, and sharing personal and team notes.

![HackMD logo](https://mintcdn.com/composio-preview/o1IUBrrsmtgkhmyf/images/toolkits/hackmd.svg?fit=max\&auto=format\&n=o1IUBrrsmtgkhmyf\&q=85\&s=075f667c99e6010082de11ae8d6ba02e)

* **Category:** documents
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 8
* **Triggers:** 0
* **Slug:** `HACKMD`
* **Version:** 00000000\_00

## Tools

> [accordion] Create Note
>
> **Slug:** `HACKMD_CREATE_NOTE`
>
> Create a Markdown note in the personal workspace or a specified team workspace. The team branch is documented but was not live-tested because the test account belongs to no teams.
>
> #### Input Parameters
>
> **tags** `array`
>
> Tags to assign to the note.
>
> **title** `string`
>
> Note title.
>
> **content** `string`
>
> Initial note body as Markdown. Content creation was live-verified; later content replacement is intentionally unavailable.
>
> **team\_path** `string`
>
> Team path from HACKMD\_GET\_ACCOUNT. Omit for the personal workspace; team creation was not live-verified.
>
> **description** `string`
>
> Short note description.
>
> **read\_permission** `string ("owner" | "signed_in" | "guest")`
>
> Who may read the note; omit to use HackMD's default.
>
> **parent\_folder\_id** `string`
>
> Folder ID from HACKMD\_LIST\_FOLDERS in the selected workspace.
>
> **write\_permission** `string ("owner" | "signed_in" | "guest")`
>
> Who may edit the note; omit to use HackMD's default.
>
> **comment\_permission** `string ("disabled" | "forbidden" | "owners" | "signed_in_users" | "everyone")`
>
> Who may comment; omit to use HackMD's default.
>
> **suggest\_edit\_permission** `string ("disabled" | "forbidden" | "owners" | "signed_in_users")`
>
> Who may suggest edits; omit to use HackMD's default.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Account
>
> **Slug:** `HACKMD_GET_ACCOUNT`
>
> Return the HackMD profile for the connected token and the teams visible to it. Use the returned team paths with tools that accept team\_path.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Note
>
> **Slug:** `HACKMD_GET_NOTE`
>
> Get a note by ID, including its Markdown content. The personal note route can also retrieve an accessible team note, so no team selector is needed.
>
> #### Input Parameters
>
> **note\_id** `string` *required*
>
> Unique note ID returned by a note list or create call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Folders
>
> **Slug:** `HACKMD_LIST_FOLDERS`
>
> List all folders in the personal workspace, or in one team workspace when team\_path is supplied. Use a folder ID as parent\_folder\_id when creating a note. The team route is documented but was not live-tested.
>
> #### Input Parameters
>
> **team\_path** `string`
>
> Team path from HACKMD\_GET\_ACCOUNT. Omit for personal folders; the team branch was not live-verified.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Notes
>
> **Slug:** `HACKMD_LIST_NOTES`
>
> List all notes in the personal workspace, or in one team workspace when team\_path is supplied. HackMD returns the complete collection without pagination; the team route is documented but was not live-tested.
>
> #### Input Parameters
>
> **team\_path** `string`
>
> Team path from HACKMD\_GET\_ACCOUNT. Omit for the personal workspace; team access depends on the connected account's membership and was not live-verified.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Trash
>
> **Slug:** `HACKMD_LIST_TRASH`
>
> List soft-deleted notes in the personal workspace. Team trash is intentionally excluded because it requires team-admin permission and could not be live-tested.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Move Note to Trash
>
> **Slug:** `HACKMD_MOVE_NOTE_TO_TRASH`
>
> Soft-delete a note by moving it to trash in the personal workspace or an explicitly selected team workspace. This is not permanent deletion. Personal notes can be restored with HACKMD\_RESTORE\_NOTES; team deletion is documented but was not live-verified, and no team restore endpoint is mapped.
>
> #### Input Parameters
>
> **note\_id** `string` *required*
>
> Unique note ID to move to trash.
>
> **team\_path** `string`
>
> Team path from HACKMD\_GET\_ACCOUNT. Omit for a personal note; team deletion is documented but was not live-verified and has no mapped restore counterpart.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Restore Notes
>
> **Slug:** `HACKMD_RESTORE_NOTES`
>
> Restore one or more personal notes from HackMD trash. Returns a per-note success or failure outcome so a partial HTTP 207 result is never reported as an unconditional success.
>
> #### Input Parameters
>
> **note\_ids** `array` *required*
>
> One or more encoded personal trash note IDs from HACKMD\_LIST\_TRASH.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
