API Documentation

Get started with Rnote API — from sign-up to your first request.

Before you start

1. 1 Create an account and verify your email
2. 2 Sign in to the admin panel and create an API key under "API Keys"
3. 3 Top up your balance on the Billing page (only successful requests are charged)

Authentication

All API requests authenticate by passing your API key in the X-API-Key header.

# Pass your API key in an HTTP header
curl -X 'GET' \
  'https://rnote.dev/api/v2/crawler/note/image?note_id=697c0eee000000000a03c308' \
  -H 'accept: application/json' \
  -H 'X-API-Key: sk-5bc4****************************e175'

Your First Request

Example — fetching an image note's detail:

curl -X 'GET' \
  'https://rnote.dev/api/v2/crawler/note/image?note_id=697c0eee000000000a03c308' \
  -H 'accept: application/json' \
  -H 'X-API-Key: sk-5bc4****************************e175'

import requests

API_KEY = "sk-5bc4****************************e175"
BASE_URL = "https://rnote.dev/api/v2/crawler"

response = requests.get(
    f"{BASE_URL}/note/image",
    params={"note_id": "697c0eee000000000a03c308"},
    headers={
        "X-API-Key": API_KEY,
        "accept": "application/json",
    },
)

data = response.json()
print(data)

const API_KEY = "sk-5bc4****************************e175";
const BASE_URL = "https://rnote.dev/api/v2/crawler";

const res = await fetch(
  `${BASE_URL}/note/image?note_id=697c0eee000000000a03c308`,
  {
    headers: {
      "X-API-Key": API_KEY,
      "accept": "application/json",
    },
  }
);

const data = await res.json();
console.log(data);

Note APIs

User APIs

Search APIs

Product APIs

Topic APIs

Creator Insights

Response Format

All data endpoints (/api/v2/crawler/*, /api/v2/pgy/*) use a consistent JSON envelope:

Successful response

{
  "success": true,
  "data": { /* Business data, shape varies by endpoint */ },
  "billed": true,
  "debug_id": "a1b2c3d4",
  "debug_info": "..."   /* diagnostic info — include it when reporting an issue */
}

Failure response

{
  "success": false,
  "data": null,
  "error": "Rate limited, please retry later",
  "retry_after": 5.0,
  "billed": false,
  "debug_id": "a1b2c3d4",
  "debug_info": "..."   /* diagnostic info — include it when reporting an issue */
}

Field reference

Error Codes

Middleware layer (auth / rate-limit / billing)

These statuses are returned before the request reaches business logic, regardless of endpoint.

Business layer (data endpoints)

Data endpoints use standard 4xx/5xx HTTP status codes on failure, plus a Retry-After header where relevant. Check both the HTTP status and body.success.

Client error-handling example

Recommended pattern — check both HTTP status and body.success, and include debug_id in your error logs:

import requests

resp = requests.get(
    "https://rnote.dev/api/v2/crawler/user/info",
    headers={"X-API-Key": "sk-..."},
    params={"user_id": "..."},
    timeout=20,
)
body = resp.json()

# Double-check: HTTP status first, body.success fallback
if resp.status_code >= 400 or not body.get("success"):
    error = body.get("error", "Unknown error")
    debug_id = body.get("debug_id", "n/a")
    retry_after = body.get("retry_after")
    print(f"Request failed [{debug_id}]: {error}", end="")
    if retry_after:
        print(f" (retry in {retry_after}s)")
    # Include debug_id when contacting support
else:
    data = body["data"]
    # Process business data ...

Billing