Docs Reorganised: Playground or Swagger UI, and When to Use Which
The docs page has been reorganised: endpoints are now grouped into two families — RedNote data and Pugongying (Dandelion) data — and Pugongying is no longer one crowded bucket but six sub-sections (blogger basics, note cases, discovery, note dimensions, content square, keyword analytics), each linked from the table of contents.
Both debugging entry points now live on that page too. Here's the difference and when to use which.
Two entry points
Interactive playground (docs.rnote.dev) — a standalone site organised by use case. Best for your first hour: you want to know what an endpoint returns, so you fill in a parameter and click.
Swagger UI (/docs) — generated from the OpenAPI spec, same source as the backend code, so it is always in sync with the real API. Best while writing code: the exact parameter name, type, default and allowed values.
Choosing
| What you want | Use |
|---|---|
| See what this endpoint returns | Playground |
| Look up an exact parameter name and type | Swagger UI |
| Show a colleague what data is available | Playground |
| Copy field names while coding | Swagger UI |
| Confirm an endpoint actually exists | Swagger UI (generated from code — it can't drift) |
That last row is worth spelling out: hand-written docs drift, generated ones don't. If you see an endpoint somewhere that Swagger doesn't list, trust Swagger.
Free test key
To try before topping up, request a free test key from the source code page in the dashboard: valid 1 day, 20 requests/minute, 100 per day, one per account. Paste it into Authorize at the top right of the demo console and hit Try it out.
Exceeding the rate or daily cap returns 429 — it is not a charge. Trials never cost anything.
What else is on the docs page
- Quick start / authentication / first request — from sign-up to a working call.
- Both endpoint families — 41 endpoints with parameters and examples.
- Response format / error codes / billing — the three sections you'll come back to during integration.
- Self-hosting — if you'd rather run the whole stack yourself, this section covers how it differs from the hosted API.
Get started
Sign up free, then request a test key. Endpoints are in the docs and prices on the pricing page.