HackMD website screenshot

HackMD

HackMD is a real-time collaborative Markdown editor and knowledge base for individuals and teams. Multiple people can co-edit a Markdown document live, organize notes into folders and team workspaces, and publish them as web pages, slide decks or books. HackMD exposes a v1 REST API at api.hackmd.io that lets developers programmatically create, read, update and delete personal and team notes, manage folders and folder ordering, upload image attachments, restore notes from trash, and read the current user profile and view history. The API authenticates with a personal access token sent as an HTTP bearer credential, is described by a published OpenAPI 3.0 specification and Swagger UI, ships an official Node.js/TypeScript client (@hackmd/api) and command-line interface, and advertises its full developer surface through an RFC 9727 api-catalog. HackMD is a Techstars-backed company.

HackMD publishes 12 API contracts indexed on the APIs.io network, including History API, Profile API, Team Folders API, and 9 more. Tagged areas include Company, Markdown, Collaboration, Documentation, and Note Taking.

The HackMD catalog on APIs.io includes 1 Spectral governance ruleset.

HackMD’s developer surface includes documentation, API reference, getting-started guide, engineering blog, pricing, signup flow, changelog, and 26 more developer resources.

61.3/100 strong ▬ flat Agent 32/100 agent ready Front door AI 3/6 light Heartbeat 100/100 alive saas Full breakdown ↓
scored 2026-11-06 · rubric v0.27.0 · Show this score on your site →
AccessFreemiumSelf serve⚡ Free to try
1 published contract 3 Agent Skills
CompanyMarkdownCollaborationDocumentationNote TakingKnowledge BaseProductivityContent

What this lets a business do 1

Business capabilities this provider's published APIs can perform, derived from its own contracts. Browse all capabilities →

Knowledge Management
BC-830
User Notes
POST /notes PATCH /notes/{noteId}

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-11-06 · rubric v0.27.0
Regulatory Posture applies to this provider. Its tags matched the Horizontal (data, software, accessibility, platform) regime, so Regulatory Posture carries 15 points of the composite. If this regime is wrong for your business, say so on your provider repo — the applicability map is public and we will correct it.
Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it carries 10 points of the composite. It is scored from the published contracts themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in front of it, and the first time that check is skipped a duplicate record is created. Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet, not penalised by it.
The six quality facets above are damped to 75 points between them, because the conditional facet above carries the other 25. That is why each facet's contribution is shown against a damped maximum: raising a quality facet moves the composite by 75% of its nominal weight, not 100%. The full arithmetic is at apis.io/rating/.
Show this score on your site. Kin Score badge preview for HackMD It updates itself when the score changes. Paste this where you link to your API docs:
<a href="https://apis.io/providers/hackmd/"><img src="https://apis.io/badge/hackmd/card.svg" alt="HackMD on APIs.io — Kin Score by API Evangelist"></a>
Other styles, a README pill and a shields.io endpoint are on the badge page.
Raise your score.
Agent readiness — checks not met, largest first (exact, from this profile):
  • MCP Server +12 pts — deployment.mode + probe verdict on the mcp/ manifest, not the pointer; an unprobed slug falls back to authorship
  • Agentic Access Contract +10 pts — agentic_access artifact present (x-agentic-access), graded by author
  • Idempotency +9 pts — OpenAPI mutating operations declare an idempotency key — a header, a request-body property, or a named de-duplication token whose own description says so (verified); else common[].type matches /idempoten/i (documented)
  • A2A Agent Card +8 pts — a2a/-a2a.yml manifest, graded on conformance.grade against A2A 1.0.0
  • Registration Without a Human +6 pts — a `registration_endpoint` in the served RFC 8414 / OIDC discovery document
  • Delegated User Identity +6 pts — a served discovery document listing authorization_code in grant_types_supported (served), else an oauth2 authorizationCode flow or openIdConnect declared in an OpenAPI (documented)
6 more unmet checks in the Agent Readiness table above.
Kin Score — facets with the most composite points still available (weight × headroom):
Each check links to what satisfies it. Publish the artifact, or tell us where it already lives, and the score moves on the next scoring run.
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. Every facet and dimension name above is a link: it opens that measurement's own page — what it means, the exact checks that feed it, how the whole catalog distributes on it, and the providers at the top of it. This rating is computed from the provider profile at artifacts.apis.io/hackmd/apis.yml: open an issue on github.com/api-evangelist/hackmd to ask a question or point us at an artifact you publish. Submit an artifact on GitHub — free → Manage your own listing — the Influence plan, $499/mo →

Markets this provider is in provisional

The Kin Score Market layer reads a provider inside its market: its position, and how deep its integrations go. Depth is only comparable within a position. Provisional and unweighted: not part of the Kin Score or agent readiness.

MarketPositionDepthRegistered MCP serverDeclares compatibility
Agent Skills (SKILL.md packages) builds-on 24.9 - 1
Obsidian Community Plugins (third-party APIs the Obsidian plugin ecosystem integrates) builds-on 24.9 - 1

Registered MCP server and declares compatibility are report only — not weighted. Undeclared means we found nothing we can read, so there is no number: we never infer integrations.

Standards implemented 2

Standards this provider implements or carries. De facto ones are profiled and measured by the API Commons; formal ones come from the standards directory and are linked by the provider's own tags. The evidence column says how each claim was established — not that it was made.

tagged — the provider's own APIs.json carries the standard as a tag; implementation not verified
measured — observed by APIs.io (published)

APIs 12

Individual APIs this provider publishes, each with its own machine-readable definition.

HackMD History API

Operations related to user's note history.

HackMD Profile API

Operations to retrieve user profile information.

HackMD Team Folders API

Operations related to folders within a team.

HackMD Team Notes API

Operations related to notes within a team.

HackMD Teams API

Operations related to user teams.

HackMD Trash API

Operations for listing and restoring trashed notes.

HackMD User Folders API

Operations related to a user's personal folders.

HackMD User Notes API

Operations related to a user's personal notes.

HackMD Comments API

Operations for reading and resolving note comments.

HackMD Team Webhooks API

Operations for managing webhooks in a team workspace.

HackMD Versions API

Operations for listing, retrieving, comparing, creating, and updating note versions.

HackMD Webhooks API

Operations for managing webhooks in a personal workspace.

Scroll for all 12

Open Collections 8

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

HackMD Open History API

OPEN COLLECTION

Scroll for all 8

Agent Skills 3

Packaged agent skills for driving this provider's APIs from an AI assistant.

HackMD API pricing

Prices published by HackMD, read 2026-10-28 from hackmd.io/pricing.

PlanPrice
Free $0
Includes: Unlimited notes, 3 invitees, 3 custom templates, 20 GitHub pushes per month, up to 1MB per image, 40
Prime $5 per seat/mo
Includes: Full-text search, up to 20MB per image, PDF export, unlimited invites/versions/GitHub pushes/custom
Enterprise Request a demo ->
Includes: Everything in Prime, plus RBAC, SSO, custom domain, GitLab integration, self-hosting, dedicated acco

Plan details, limits and sources →

Billed by: team · FinOps profile →

Pricing Plans 2

Published pricing tiers and plan structures.

Hackmd Plans Pricing

3 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Hackmd Rate Limits

2 limits

RATE LIMITS

Service Levels 1

Uptime the provider promises or reports, as SLA4OAI. Read from its own pages; APIs.io runs no monitors.

HackMD

SLA

FinOps 1

Cost, billing, and metering signals for API financial operations.

Spectral Rules 1

Spectral governance rulesets for linting and validating these APIs.

HackMD API Rules

66 rules · 57 errors 8 warnings 1 info

SPECTRAL

OpenAPI Overlays 1

Overlays applied on top of this provider's contracts. Each card says who wrote it: a document the provider publishes, or one API Evangelist derived or generated.

Hackmd Openapi Overlay

3 actions · documentation · hackmd-openapi-original.json

DERIVED

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Hackmd Authentication

http · 1 scheme

SECURITY

Hackmd Domain Security

TLSv1.2 · HSTS · DNSSEC · DMARC

SECURITY

Resources

Get Started 3

Portal, sign-up, and the first successful call

Documentation 3

Reference material describing how the API behaves

Agent Surfaces 4

MCP servers, agent skills, and machine-readable catalogs

Design & Contract 5

Pagination, idempotency, versioning, errors, and events

Build 4

SDKs, sample code, and the tooling you integrate with

Access & Security 2

Authentication, authorization, and security posture

Operate 3

Status, limits, changes, and where to get help

Commercial 4

Pricing, plans, and the legal terms of use

Company 2

The organization behind the API

Other 3

Properties that don't map to a standard resource type

Source (apis.yml)

apis.yml Raw ↑
aid: hackmd
name: HackMD
description: HackMD is a real-time collaborative Markdown editor and knowledge base for individuals and teams. Multiple people
  can co-edit a Markdown document live, organize notes into folders and team workspaces, and publish them as web pages, slide
  decks or books. HackMD exposes a v1 REST API at api.hackmd.io that lets developers programmatically create, read, update
  and delete personal and team notes, manage folders and folder ordering, upload image attachments, restore notes from trash,
  and read the current user profile and view history. The API authenticates with a personal access token sent as an HTTP bearer
  credential, is described by a published OpenAPI 3.0 specification and Swagger UI, ships an official Node.js/TypeScript client
  (@hackmd/api) and command-line interface, and advertises its full developer surface through an RFC 9727 api-catalog. HackMD
  is a Techstars-backed company.
deliveryModel:
  model: saas
  open_source: false
  commercial: true
  callable_host: false
  label: Hosted service · you call their endpoint
  confidence: medium
  source:
  - openapi
  - pricing
  generated: '2026-08-28'
  method: derived
accessModel:
  pricing: freemium
  onboarding: self-serve
  trial: false
  try_now: true
  public: false
  gated: none
  gated_source:
  - onboarding
  label: Freemium · Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  - rate-limits
  - security
  generated: '2026-11-06'
  method: derived
image: https://hackmd.io/favicon.png
url: https://raw.githubusercontent.com/api-evangelist/hackmd/refs/heads/main/apis.yml
x-type: company
x-source: vc-portfolio
x-backed-by:
- techstars
x-tier: stub
x-tier-reason: portfolio-lead
specificationVersion: '0.23'
created: '2026-07-17'
modified: '2026-07-19'
tags:
- Company
- Markdown
- Collaboration
- Documentation
- Note Taking
- Knowledge Base
- Productivity
- Content
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com
- FN: APIs.json
  email: info@apis.io
apis:
- aid: hackmd:hackmd-history-api
  name: HackMD History API
  description: Operations related to user's note history.
  humanURL: https://hackmd.io/@docs/developer-portal
  baseURL: https://api.hackmd.io/v1
  tags:
  - History
  properties:
  - type: OpenAPI
    url: openapi/hackmd-history-api-openapi.yml
  - type: APIReference
    url: https://api.hackmd.io/v1/docs/
  - type: Documentation
    url: https://hackmd.io/@docs/developer-portal
  - type: Authentication
    url: authentication/hackmd-authentication.yml
  - type: RateLimits
    url: rate-limits/hackmd-rate-limits.yml
- aid: hackmd:hackmd-profile-api
  name: HackMD Profile API
  description: Operations to retrieve user profile information.
  humanURL: https://hackmd.io/@docs/developer-portal
  baseURL: https://api.hackmd.io/v1
  tags:
  - Profiles
  tags_raw:
  - Profile
  properties:
  - type: OpenAPI
    url: openapi/hackmd-profile-api-openapi.yml
  - type: APIReference
    url: https://api.hackmd.io/v1/docs/
  - type: Documentation
    url: https://hackmd.io/@docs/developer-portal
  - type: Authentication
    url: authentication/hackmd-authentication.yml
  - type: RateLimits
    url: rate-limits/hackmd-rate-limits.yml
- aid: hackmd:hackmd-team-folders-api
  name: HackMD Team Folders API
  description: Operations related to folders within a team.
  humanURL: https://hackmd.io/@docs/developer-portal
  baseURL: https://api.hackmd.io/v1
  tags:
  - Team Folders
  properties:
  - type: OpenAPI
    url: openapi/hackmd-team-folders-api-openapi.yml
  - type: APIReference
    url: https://api.hackmd.io/v1/docs/
  - type: Documentation
    url: https://hackmd.io/@docs/developer-portal
  - type: Authentication
    url: authentication/hackmd-authentication.yml
  - type: RateLimits
    url: rate-limits/hackmd-rate-limits.yml
- aid: hackmd:hackmd-team-notes-api
  name: HackMD Team Notes API
  description: Operations related to notes within a team.
  humanURL: https://hackmd.io/@docs/developer-portal
  baseURL: https://api.hackmd.io/v1
  tags:
  - Team Notes
  properties:
  - type: OpenAPI
    url: openapi/hackmd-team-notes-api-openapi.yml
  - type: APIReference
    url: https://api.hackmd.io/v1/docs/
  - type: Documentation
    url: https://hackmd.io/@docs/developer-portal
  - type: Authentication
    url: authentication/hackmd-authentication.yml
  - type: RateLimits
    url: rate-limits/hackmd-rate-limits.yml
- aid: hackmd:hackmd-teams-api
  name: HackMD Teams API
  description: Operations related to user teams.
  humanURL: https://hackmd.io/@docs/developer-portal
  baseURL: https://api.hackmd.io/v1
  tags:
  - Team
  tags_raw:
  - Teams
  properties:
  - type: OpenAPI
    url: openapi/hackmd-teams-api-openapi.yml
  - type: APIReference
    url: https://api.hackmd.io/v1/docs/
  - type: Documentation
    url: https://hackmd.io/@docs/developer-portal
  - type: Authentication
    url: authentication/hackmd-authentication.yml
  - type: RateLimits
    url: rate-limits/hackmd-rate-limits.yml
- aid: hackmd:hackmd-trash-api
  name: HackMD Trash API
  description: Operations for listing and restoring trashed notes.
  humanURL: https://hackmd.io/@docs/developer-portal
  baseURL: https://api.hackmd.io/v1
  tags:
  - Trash
  properties:
  - type: OpenAPI
    url: openapi/hackmd-trash-api-openapi.yml
  - type: APIReference
    url: https://api.hackmd.io/v1/docs/
  - type: Documentation
    url: https://hackmd.io/@docs/developer-portal
  - type: Authentication
    url: authentication/hackmd-authentication.yml
  - type: RateLimits
    url: rate-limits/hackmd-rate-limits.yml
- aid: hackmd:hackmd-user-folders-api
  name: HackMD User Folders API
  description: Operations related to a user's personal folders.
  humanURL: https://hackmd.io/@docs/developer-portal
  baseURL: https://api.hackmd.io/v1
  tags:
  - User Folders
  properties:
  - type: OpenAPI
    url: openapi/hackmd-user-folders-api-openapi.yml
  - type: APIReference
    url: https://api.hackmd.io/v1/docs/
  - type: Documentation
    url: https://hackmd.io/@docs/developer-portal
  - type: Authentication
    url: authentication/hackmd-authentication.yml
  - type: RateLimits
    url: rate-limits/hackmd-rate-limits.yml
- aid: hackmd:hackmd-user-notes-api
  name: HackMD User Notes API
  description: Operations related to a user's personal notes.
  humanURL: https://hackmd.io/@docs/developer-portal
  baseURL: https://api.hackmd.io/v1
  tags:
  - User Notes
  properties:
  - type: OpenAPI
    url: openapi/hackmd-user-notes-api-openapi.yml
  - type: APIReference
    url: https://api.hackmd.io/v1/docs/
  - type: Documentation
    url: https://hackmd.io/@docs/developer-portal
  - type: Authentication
    url: authentication/hackmd-authentication.yml
  - type: RateLimits
    url: rate-limits/hackmd-rate-limits.yml
- aid: hackmd:hackmd-comments-api
  name: HackMD Comments API
  description: Operations for reading and resolving note comments.
  humanURL: https://hackmd.io/@docs/developer-portal
  baseURL: https://api.hackmd.io/v1
  tags:
  - Comments
  properties:
  - type: OpenAPI
    url: openapi/hackmd-comments-api-openapi.yml
- aid: hackmd:hackmd-team-webhooks-api
  name: HackMD Team Webhooks API
  description: Operations for managing webhooks in a team workspace.
  humanURL: https://hackmd.io/@docs/developer-portal
  baseURL: https://api.hackmd.io/v1
  tags:
  - Team Webhooks
  properties:
  - type: OpenAPI
    url: openapi/hackmd-team-webhooks-api-openapi.yml
- aid: hackmd:hackmd-versions-api
  name: HackMD Versions API
  description: Operations for listing, retrieving, comparing, creating, and updating note versions.
  humanURL: https://hackmd.io/@docs/developer-portal
  baseURL: https://api.hackmd.io/v1
  tags:
  - Versions
  properties:
  - type: OpenAPI
    url: openapi/hackmd-versions-api-openapi.yml
- aid: hackmd:hackmd-webhooks-api
  name: HackMD Webhooks API
  description: Operations for managing webhooks in a personal workspace.
  humanURL: https://hackmd.io/@docs/developer-portal
  baseURL: https://api.hackmd.io/v1
  tags:
  - Webhook
  tags_raw:
  - Webhooks
  properties:
  - type: OpenAPI
    url: openapi/hackmd-webhooks-api-openapi.yml
common:
- type: CapabilityMap
  url: capabilities/hackmd-capability-edges.yml
  name: HackMD Business Capability Map
- type: Plans
  url: plans/hackmd-plans-pricing.yml
- type: Website
  url: https://hackmd.io/
- type: DeveloperPortal
  url: https://hackmd.io/@docs/developer-portal
- type: Documentation
  url: https://hackmd.io/@docs/developer-portal
- type: APIReference
  url: https://api.hackmd.io/v1/docs/
- type: GettingStarted
  url: https://hackmd.io/@docs/how-to-issue-an-api-token
- type: GitHubOrganization
  url: https://github.com/hackmdio
- type: Blog
  url: https://hackmd.io/blog
- type: Pricing
  url: https://hackmd.io/pricing
- type: SignUp
  url: https://hackmd.io/login
- type: TermsOfService
  url: https://hackmd.io/s/terms
- type: PrivacyPolicy
  url: https://hackmd.io/s/privacy
- type: StatusPage
  url: https://status.hackmd.io/
- type: ChangeLog
  url: changelog/hackmd-changelog.yml
- type: Authentication
  url: authentication/hackmd-authentication.yml
- type: OpenAPI
  url: openapi/_original/hackmd-openapi-original.json
- type: Overlay
  url: overlays/hackmd-openapi-overlay.yaml
- type: Packages
  url: packages/hackmd-packages.yml
- type: SDKs
  url: packages/hackmd-packages.yml
- type: CLI
  url: cli/hackmd-cli.yml
- type: X-MCPServerCandidate
  url: mcp/hackmd-mcp.yml
  note: 'Renamed from MCPServer 2026-09-03 (roadmap#247): the manifest self-describes as status: candidate — a tool list derived
    from the published API contracts, not an existing server. The scorer already read the manifest and reported mcp_server
    correctly; the MCPServer type was crediting the artifact-type surfaces with a server that does not exist.'
- type: AgentSkill
  url: skills/_index.yml
- type: LLMsTxt
  url: llms/hackmd-llms.txt
- type: WellKnown
  url: well-known/hackmd-well-known.yml
- type: APICatalog
  url: well-known/hackmd-api-catalog.json
- type: Conventions
  url: conventions/hackmd-conventions.yml
- type: ErrorCatalog
  url: errors/hackmd-problem-types.yml
- type: RateLimits
  url: rate-limits/hackmd-rate-limits.yml
- type: Lifecycle
  url: lifecycle/hackmd-lifecycle.yml
- type: DataModel
  url: data-model/hackmd-data-model.yml
- type: Conformance
  url: conformance/hackmd-conformance.yml
- type: DomainSecurity
  url: security/hackmd-domain-security.yml
x-enrichment:
  date: '2026-07-19'
  status: backfilled
  pass: local-v1
  note: backfilled from .gitignore signal + verified work evidence

HackMD API — frequently asked questions

Does HackMD have an API?

Yes. APIs.io lists 12 APIs from HackMD, including HackMD History API, HackMD Profile API and HackMD Team Folders API, and 9 more.

Is there an OpenAPI specification for the HackMD API?

Yes. APIs.io indexes 12 OpenAPI specifications for HackMD, each linked for download from this page.

How do I authenticate with the HackMD API?

HackMD uses bearer-token authentication (http · 1 scheme). The details are profiled on APIs.io as Hackmd Authentication.

How much does the HackMD API cost?

HackMD publishes its prices; its Free plan is $0 as of 2026-10-28. APIs.io lists 3 pricing plans for HackMD, with each plan's price, limits and inclusions under Pricing on this page.

Is the HackMD API ready for AI agents?

HackMD has a Kin Score of 61.3 out of 100 (strong) and an Agent Readiness score of 32.1 (agent-ready), scored by API Evangelist on 2026-11-06.

Work with this as data

Every provider here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for providers

9 MCP tools reach this
  • find_providersBrowse and filter every provider in the catalog.
  • get_provider_artifactsEvery artifact this provider publishes, grouped by type.
  • get_provider_operationsEvery operation across all of their OpenAPIs — one call instead of parsing every spec.
  • get_provider_toolsEvery MCP tool they ship, with the operation each wraps.
  • get_provider_evidenceHow each part of their score was established. Free — the basis for a claim should not sit behind it.
  • get_provider_ratingPRO — composite, band, trend and facet scores.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This provider
curl "https://apis.io/api/v1/providers/hackmd"
All providers
curl "https://apis.io/api/v1/providers?limit=25"
Every operation they expose
curl "https://apis.io/api/v1/providers/hackmd/operations?limit=25"
How their score was established
curl "https://apis.io/api/v1/providers/hackmd/evidence"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.