HackMD API

@hackmd-api

Collection of use cases and how-to guides.

Public team

Joined on Dec 12, 2021

  • Getting Started Policy Report issues Status Page Documentation Create token Authentication Attachments API Swagger Documentation <br><small class="bg-green-default px-2 rounded">New!</small>
     Like 3 Bookmark
  • Team Notes API [!Caution] This page of API documentation is deprecated. Please refer to the new Swagger Documentation instead. Get a list of notes in a Team's workspace GET /teams/:teamPath/notes URL ParamsteamPath: string Success Response
     Like 4 Bookmark
  • Teams API [!Caution] This page of API documentation is deprecated. Please refer to the new Swagger Documentation instead. Get a list of the teams to which the user has permission GET /teams Success Responsecode: 200 body:​​​​​​ [ ​​​​​​ { ​​​​​​ "id": "e9ed1dcd-830f-435c-9fe2-d53d5f191666",
     Like 4 Bookmark
  • HackMD User API [!Caution] This page of API documentation is deprecated. Please refer to the new Swagger Documentation instead. Get user information GET /me Success Responsecode: 200 body:​​​​​​​​ { ​​​​​​​​ "id": "00c437e8-9d79-4200-997f-8e9384415a76", ​​​​​​​​ "name": "James",
     Like 4 Bookmark
  • User Notes API [!Caution] This page of API documentation is deprecated. Please refer to the new Swagger Documentation instead. Get a list of notes in the user's workspace GET /notes Success Responsecode: 200 body:​​​​​​ [ ​​​​​​ { ​​​​​​ "id": "ehgwc6a8RXSmcSaRwIQ2jw",
     Like 14 Bookmark
  • HackMD API authentication Bearer Authentication Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The name "Bearer authentication" can be understood as "give access to the bearer of this token." The bearer token is a cryptic string, usually generated by the server in response to a login request. The client must send this token in the Authorization header when making requests to protected resources: :::info Header: Authorization Bearer <token> ::: <token> can be created in your Settings, take a look at How to issue an API token.
     Like 7 Bookmark
  • :::success You have found HackMD developer portal, congratulations! :tada: ::: This portal is built with HackMD Book Mode, collecting all resources you need and showing various ways you can use HackMD to make cool stuff. ▲ Live updating contents via Note API
     Like 40 Bookmark
  • HackMD API Policy Last updated: February 11, 2022. The polices listed below serve as a guideline for using HackMD API. They are incorporated in our terms of service. Do not abuse the data You may not use the APIs in any way to: scrape HackMD Data; use HackMD Data for any purpose other than as necessary for your application;
     Like 5 Bookmark
  • Discord Integration | Discord 整合 Suggested by Description HackMD Profile 未來 Discord @Mirai1129 Introduce
     Like 4 Bookmark
  • 2024-03-19 Added Attachment Download API 2020-08-18 Added User and Notes API
     Like 7 Bookmark
  • Attachments API Upload an image to a note coming soon Download an attachment GET https://hackmd.io/_uploads/:filename Url params:filename: string Authorization:
     Like 1 Bookmark
  • --- title: Developer Portal Styles tags: developer portal, css --- <style> .ui-infobar { display: none !important; } .ui-toc, .ui-affix-toc { display: none !important; } p > img:not(.emoji), p > img:not(.emoji) + span { display: block; margin: 0 auto; text-align: center; } </style>
     Like 2 Bookmark
  • {%hackmd bXqUSiOGTLuFjPgSJ74wxQ %} How to issue an API token [toc] Issue an API token Access My account > Settings at the Overview. ![](https://hackmd.io/_uploads/ryF6s9Qy5.png =200x)
     Like 16 Bookmark
  • 從 HackMD 播放 Spotify 上的音樂。 Suggested by Description HackMD Profile Steve I want to stream the music with Spotify! Make my hackmd page have LOFI as background music. @song856854132
     Like 3 Bookmark
  • Suggested by Description HackMD Profile Rowan Dempster I would like to be able to make an API request via Google App Scripts to add a user to my HackMD team. N/A
     Like 3 Bookmark
  • Suggested by Description HackMD Profile 鄭智元 VSCode @idisused 目前 HackMD 有 VSCode 擴充套件,可以在 VSCode 裡瀏覽 HackMD 上的筆記並開啟在 HackMD 中編輯。
     Like 2 Bookmark