墨问 API

笔记创建

POST

/api/open/api/v1/note/create

OpenAPI笔记

笔记创建

请求参数

Header 参数

Authorization

string

可选

默认值:

Bearer {{API-KEY}}

Body 参数application/json

body

allOf {1}

笔记内容

可选

object (NoteAtom)

笔记-原子节点信息

可选

settings

object

笔记设置

可选

autoPublish

boolean

自动发布

可选

tags

array[string]

可选

标签
标签列表 <= 10 个
标签名长度 <= 30 个字符

示例

{
    "body": {
        "type": "string",
        "text": "string",
        "content": [
            {}
        ],
        "marks": [
            {}
        ],
        "attrs": {
            "property1": "string",
            "property2": "string"
        }
    },
    "settings": {
        "autoPublish": true,
        "tags": [
            "string"
        ]
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/open/api/v1/note/create' \
--header 'Authorization: Bearer {{API-KEY}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "body": {
        "type": "string",
        "text": "string",
        "content": [
            {}
        ],
        "marks": [
            {}
        ],
        "attrs": {
            "property1": "string",
            "property2": "string"
        }
    },
    "settings": {
        "autoPublish": true,
        "tags": [
            "string"
        ]
    }
}'

返回响应

🟢200成功

application/json

Body

noteId

string

笔记ID

可选

示例

{
    "noteId": "string"
}

🔴500服务器错误

APIKey 重置

笔记编辑