跳转至

创建



POST /api/v1/notes_v2/create

概述

创建新版笔记。

Body 请求参数

参数名 类型 必选 说明
title string Y 笔记标题
允许为空: False
content string Y Markdown 正文
允许为空: False
tags array 标签列表
允许为空: False
tagKV json 键值标签
允许为空: False
isPublic int 是否公开,1 公开,0 私有,默认 1
允许为空: False
extend json Studio 业务扩展字段
允许为空: False

参数补充说明

使用该接口创建新版笔记。请求体至少需要传 titlecontent,可选传 tagstagKVisPublicextend

  • 不需要传笔记存储路径,也不要传 noteUUID;创建成功后从响应中读取 noteUUID
  • isPublic 不传时默认为公开笔记;传 0 表示私有笔记。
  • 创建成功后,后续获取、修改、删除都使用响应里的 noteUUID
  • 响应中的 etag 可作为首次编辑或删除时的 ifMatch

请求例子

curl 'https://openapi.guance.com/api/v1/notes_v2/create' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"title":"A","content":"# A","tags":["ops"],"tagKV":{"host":"127.0.0.1"}}'

响应

{
    "code": 200,
    "content": {
        "noteUUID": "nbnote_xxx",
        "title": "A",
        "tags": [
            "ops"
        ],
        "tagKV": {
            "host": "127.0.0.1"
        },
        "isPublic": 1,
        "createdSource": "manual",
        "etag": "etag_xxx",
        "version": 1
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}

文档评价

文档内容是否对您有帮助? ×