# HTMLRadar API

**Canonical:** https://apis.io/apis/htmlradar-com/htmlradar-com-api/  
**Provider:** HTMLRadar — https://apis.io/providers/htmlradar-com/  
**Documentation:** https://htmlradar.com/docs/api

HTMLRadar API is one of 2 APIs that [HTMLRadar](https://apis.io/providers/htmlradar-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

HTMLRadar API as documented publicly: 15 operations. Contract generated from the documentation by API Evangelist (2026-11-11); not the provider's own document.

## Operations (15)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v1/documents` | GET /api/v1/documents The account’s documents, newest first, with how many links point at each one. |
| GET | `/api/v1/documents/{id}/attachments` | The HTMLRadar API is the same set of calls the dashboard and the MCP server use to create tracked links, list them, read who opened one, change a link’s sett... |
| POST | `/api/v1/documents/{id}/attachments` | POST /api/v1/documents/{id}/attachments POST attaches one file. |
| DELETE | `/api/v1/documents/{id}/attachments/{attachmentid}` | DELETE /api/v1/documents/{id}/attachments/{attachmentId} Removes one file from a document. |
| GET | `/api/v1/documents/{id}/html` | GET /api/v1/documents/{id}/html A document’s current contents, so they can be changed and sent back to /replace. |
| GET | `/api/v1/documents/{id}/reading-records` | GET /api/v1/documents/{id}/reading-records The same reading the report shows, as a CSV file. |
| POST | `/api/v1/documents/{id}/replace` | POST /api/v1/documents/{id}/replace Puts new content behind every link already sent. |
| GET | `/api/v1/me` | GET /api/v1/me reports whether this key works, and which plan it is on. |
| POST | `/api/v1/me` | POST /api/v1/me |
| GET | `/api/v1/shares` | GET /api/v1/shares The account’s links, newest first, fifty at a time. |
| POST | `/api/v1/shares` | POST /api/v1/shares Turns HTML into a tracked link, or adds a second link to a document you already created. |
| GET | `/api/v1/shares/{id}` | GET /api/v1/shares/{id} GET returns the link’s current settings in the shape PATCH takes them. |
| PATCH | `/api/v1/shares/{id}` | PATCH /api/v1/shares/{id} PATCH changes a link’s settings in place. |
| GET | `/api/v1/shares/{id}/activity` | GET /api/v1/shares/{id}/activity Whether the link was opened, by whom, how long they read, how far they scrolled, and which sections they read. |
| POST | `/api/v1/shares/{id}/revoke` | POST /api/v1/shares/{id}/revoke Switches a link off. |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/htmlradar-com/openapi/_ae-authored/htmlradar-com-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/htmlradar-com/json-schema/htmlradar-com-post-api-v1-shares-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/htmlradar-com/json-schema/htmlradar-com-patch-api-v1-shares-id-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/htmlradar-com/json-schema/htmlradar-com-get-api-v1-me-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/htmlradar-com/json-schema/htmlradar-com-post-api-v1-me-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/htmlradar-com/json-schema/htmlradar-com-post-api-v1-documents-id-replace-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/htmlradar-com/json-schema/htmlradar-com-get-api-v1-documents-id-html-response-schema.json

## Other HTMLRadar APIs (1)

- [HTMLRadar API](https://apis.io/apis/htmlradar-com/htmlradar-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/htmlradar-com/htmlradar-com-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/htmlradar-com/.