API 使用文档

快速上手 Rnote API，从注册到发起第一个请求

开始之前

1. 1 注册账户 并完成邮箱验证
2. 2 登录 管理后台，在「API Key 管理」中创建一个 API Key
3. 3 在「计费」页面充值余额（仅成功请求扣费）

认证方式

所有 API 请求需要通过 X-API-Key Header 传递 API Key 进行认证。

# 在 HTTP Header 中传递 API Key
curl -X 'GET' \
  'https://rnote.dev/api/v1/crawler/note/image?note_id=697c0eee000000000a03c308' \
  -H 'accept: application/json' \
  -H 'X-API-Key: sk-5bc4****************************e175'

第一个请求

以获取图文笔记详情为例：

curl -X 'GET' \
  'https://rnote.dev/api/v1/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/v1/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/v1/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);

笔记接口

用户接口

搜索接口

商品接口

话题接口

创作灵感

响应格式

所有成功响应返回小红书原始 JSON 数据。错误响应使用统一格式：

{
  "detail": "错误描述信息"
}

错误码

计费说明