API_ja_JP.md
エンドポイント: http://127.0.0.1:6806
すべてPOSTメソッドを使用
パラメータを持つインターフェースでは、パラメータはJSON文字列としてbodyに配置し、ヘッダーのContent-Typeはapplication/jsonとする
戻り値
{
"code": 0,
"msg": "",
"data": {}
}
code: 0以外は例外を示すmsg: 通常は空文字列、異常時にはエラーテキストが返されるdata: インターフェースによって{}、[]、またはNULLとなる<kbd>設定 - このアプリケーションについて</kbd>でAPIトークンを確認し、リクエストヘッダーに Authorization: Token xxx を設定
/api/notebook/lsNotebooks
パラメータなし
戻り値
{
"code": 0,
"msg": "",
"data": {
"notebooks": [
{
"id": "20210817205410-2kvfpfn",
"name": "テスト用ノートブック",
"icon": "1f41b",
"sort": 0,
"closed": false
},
{
"id": "20210808180117-czj9bvb",
"name": "SiYuanユーザーガイド",
"icon": "1f4d4",
"sort": 1,
"closed": false
}
]
}
}
/api/notebook/openNotebook
パラメータ
{
"notebook": "20210831090520-7dvbdv0"
}
notebook: ノートブックID戻り値
{
"code": 0,
"msg": "",
"data": null
}
/api/notebook/closeNotebook
パラメータ
{
"notebook": "20210831090520-7dvbdv0"
}
notebook: ノートブックID戻り値
{
"code": 0,
"msg": "",
"data": null
}
/api/notebook/renameNotebook
パラメータ
{
"notebook": "20210831090520-7dvbdv0",
"name": "ノートブックの新しい名前"
}
notebook: ノートブックID戻り値
{
"code": 0,
"msg": "",
"data": null
}
/api/notebook/createNotebook
パラメータ
{
"name": "ノートブック名"
}
戻り値
{
"code": 0,
"msg": "",
"data": {
"notebook": {
"id": "20220126215949-r1wvoch",
"name": "ノートブック名",
"icon": "",
"sort": 0,
"closed": false
}
}
}
/api/notebook/removeNotebook
パラメータ
{
"notebook": "20210831090520-7dvbdv0"
}
notebook: ノートブックID戻り値
{
"code": 0,
"msg": "",
"data": null
}
/api/notebook/getNotebookConf
パラメータ
{
"notebook": "20210817205410-2kvfpfn"
}
notebook: ノートブックID戻り値
{
"code": 0,
"msg": "",
"data": {
"box": "20210817205410-2kvfpfn",
"conf": {
"name": "テスト用ノートブック",
"closed": false,
"refCreateSavePath": "",
"createDocNameTemplate": "",
"dailyNoteSavePath": "/daily note/{{now | date \"2006/01\"}}/{{now | date \"2006-01-02\"}}",
"dailyNoteTemplatePath": ""
},
"name": "テスト用ノートブック"
}
}
/api/notebook/setNotebookConf
パラメータ
{
"notebook": "20210817205410-2kvfpfn",
"conf": {
"name": "テスト用ノートブック",
"closed": false,
"refCreateSavePath": "",
"createDocNameTemplate": "",
"dailyNoteSavePath": "/daily note/{{now | date \"2006/01\"}}/{{now | date \"2006-01-02\"}}",
"dailyNoteTemplatePath": ""
}
}
notebook: ノートブックID戻り値
{
"code": 0,
"msg": "",
"data": {
"name": "テスト用ノートブック",
"closed": false,
"refCreateSavePath": "",
"createDocNameTemplate": "",
"dailyNoteSavePath": "/daily note/{{now | date \"2006/01\"}}/{{now | date \"2006-01-02\"}}",
"dailyNoteTemplatePath": ""
}
}
/api/filetree/createDocWithMd
パラメータ
{
"notebook": "20210817205410-2kvfpfn",
"path": "/foo/bar",
"markdown": ""
}
notebook: ノートブックIDpath: ドキュメントパス、/で始まり/で階層を区切る（このpathはデータベースのhpathフィールドに対応）markdown: GFM Markdownコンテンツ戻り値
{
"code": 0,
"msg": "",
"data": "20210914223645-oj2vnx2"
}
data: 作成されたドキュメントIDpathでこのインターフェースを繰り返し呼び出しても、既存のドキュメントは上書きされない/api/filetree/renameDoc
パラメータ
{
"notebook": "20210831090520-7dvbdv0",
"path": "/20210902210113-0avi12f.sy",
"title": "新しいドキュメントタイトル"
}
notebook: ノートブックIDpath: ドキュメントパスtitle: 新しいドキュメントタイトル戻り値
{
"code": 0,
"msg": "",
"data": null
}
idでドキュメントの名前を変更:
/api/filetree/renameDocByID
パラメータ
{
"id": "20210902210113-0avi12f",
"title": "新しいドキュメントタイトル"
}
id: ドキュメントIDtitle: 新しいドキュメントタイトル戻り値
{
"code": 0,
"msg": "",
"data": null
}
/api/filetree/removeDoc
パラメータ
{
"notebook": "20210831090520-7dvbdv0",
"path": "/20210902210113-0avi12f.sy"
}
notebook: ノートブックIDpath: ドキュメントパス戻り値
{
"code": 0,
"msg": "",
"data": null
}
idでドキュメントを削除:
/api/filetree/removeDocByID
パラメータ
{
"id": "20210902210113-0avi12f"
}
id: ドキュメントID戻り値
{
"code": 0,
"msg": "",
"data": null
}
/api/filetree/moveDocs
パラメータ
{
"fromPaths": ["/20210917220056-yxtyl7i.sy"],
"toNotebook": "20210817205410-2kvfpfn",
"toPath": "/"
}
fromPaths: 移動元パスtoNotebook: 移動先ノートブックIDtoPath: 移動先パス戻り値
{
"code": 0,
"msg": "",
"data": null
}
idでドキュメントを移動:
/api/filetree/moveDocsByID
パラメータ
{
"fromIDs": ["20210917220056-yxtyl7i"],
"toID": "20210817205410-2kvfpfn"
}
fromIDs: 移動元ドキュメントのIDtoID: 移動先の親ドキュメントIDまたはノートブックID戻り値
{
"code": 0,
"msg": "",
"data": null
}
/api/filetree/getHPathByPath
パラメータ
{
"notebook": "20210831090520-7dvbdv0",
"path": "/20210917220500-sz588nq/20210917220056-yxtyl7i.sy"
}
notebook: ノートブックIDpath: ドキュメントパス戻り値
{
"code": 0,
"msg": "",
"data": "/foo/bar"
}
/api/filetree/getHPathByID
パラメータ
{
"id": "20210917220056-yxtyl7i"
}
id: ブロックID戻り値
{
"code": 0,
"msg": "",
"data": "/foo/bar"
}
/api/filetree/getPathByID
パラメータ
{
"id": "20210808180320-fqgskfj"
}
id: ブロックID戻り値
{
"code": 0,
"msg": "",
"data": {
"notebook": "20210808180117-czj9bvb",
"path": "/20200812220555-lj3enxa/20210808180320-fqgskfj.sy"
}
}
/api/filetree/getIDsByHPath
パラメータ
{
"path": "/foo/bar",
"notebook": "20210808180117-czj9bvb"
}
path: 人間が読めるパスnotebook: ノートブックID戻り値
{
"code": 0,
"msg": "",
"data": [
"20200813004931-q4cu8na"
]
}
/api/asset/upload
パラメータはHTTP Multipartフォーム
assetsDirPath: アセットが保存されるフォルダパス、dataフォルダをルートパスとする、例:
"/assets/": workspace/data/assets/ フォルダ"/assets/sub/": workspace/data/assets/sub/ フォルダ通常は最初の方法を推奨、ワークスペースのassetsフォルダに保存される。サブディレクトリに配置すると副作用があるため、ユーザーガイドのアセットの章を参照。
file[]: アップロードするファイルリスト
戻り値
{
"code": 0,
"msg": "",
"data": {
"errFiles": [""],
"succMap": {
"foo.png": "assets/foo-20210719092549-9j5y79r.png"
}
}
}
errFiles: アップロード処理でエラーが発生したファイル名のリストsuccMap: 正常に処理されたファイル、キーはアップロード時のファイル名、値はassets/foo-id.pngで、既存のMarkdownコンテンツ内のアセットリンクアドレスをアップロードされたアドレスに置き換えるために使用/api/block/insertBlock
パラメータ
{
"dataType": "markdown",
"data": "foo**bar**{: style=\"color: var(--b3-font-color8);\"}baz",
"nextID": "",
"previousID": "20211229114650-vrek5x6",
"parentID": ""
}
dataType: 挿入するデータ型、markdownまたはdomdata: 挿入するデータnextID: 次のブロックのID、挿入位置を固定するために使用previousID: 前のブロックのID、挿入位置を固定するために使用parentID: 親ブロックのID、挿入位置を固定するために使用nextID、previousID、parentIDのうち少なくとも1つは値が必要、優先順位: nextID > previousID > parentID
戻り値
{
"code": 0,
"msg": "",
"data": [
{
"doOperations": [
{
"action": "insert",
"data": "<div data-node-id=\"20211230115020-g02dfx0\" data-node-index=\"1\" data-type=\"NodeParagraph\" class=\"p\"><div contenteditable=\"true\" spellcheck=\"false\">foo<strong style=\"color: var(--b3-font-color8);\">bar</strong>baz</div><div class=\"protyle-attr\" contenteditable=\"false\"></div></div>",
"id": "20211230115020-g02dfx0",
"parentID": "",
"previousID": "20211229114650-vrek5x6",
"retData": null
}
],
"undoOperations": null
}
]
}
action.data: 新しく挿入されたブロックによって生成されたDOMaction.id: 新しく挿入されたブロックのID/api/block/prependBlock
パラメータ
{
"data": "foo**bar**{: style=\"color: var(--b3-font-color8);\"}baz",
"dataType": "markdown",
"parentID": "20220107173950-7f9m1nb"
}
dataType: 挿入するデータ型、markdownまたはdomdata: 挿入するデータparentID: 親ブロックのID、挿入位置を固定するために使用戻り値
{
"code": 0,
"msg": "",
"data": [
{
"doOperations": [
{
"action": "insert",
"data": "<div data-node-id=\"20220108003710-hm0x9sc\" data-node-index=\"1\" data-type=\"NodeParagraph\" class=\"p\"><div contenteditable=\"true\" spellcheck=\"false\">foo<strong style=\"color: var(--b3-font-color8);\">bar</strong>baz</div><div class=\"protyle-attr\" contenteditable=\"false\"></div></div>",
"id": "20220108003710-hm0x9sc",
"parentID": "20220107173950-7f9m1nb",
"previousID": "",
"retData": null
}
],
"undoOperations": null
}
]
}
action.data: 新しく挿入されたブロックによって生成されたDOMaction.id: 新しく挿入されたブロックのID/api/block/appendBlock
パラメータ
{
"data": "foo**bar**{: style=\"color: var(--b3-font-color8);\"}baz",
"dataType": "markdown",
"parentID": "20220107173950-7f9m1nb"
}
dataType: 挿入するデータ型、markdownまたはdomdata: 挿入するデータparentID: 親ブロックのID、挿入位置を固定するために使用戻り値
{
"code": 0,
"msg": "",
"data": [
{
"doOperations": [
{
"action": "insert",
"data": "<div data-node-id=\"20220108003642-y2wmpcv\" data-node-index=\"1\" data-type=\"NodeParagraph\" class=\"p\"><div contenteditable=\"true\" spellcheck=\"false\">foo<strong style=\"color: var(--b3-font-color8);\">bar</strong>baz</div><div class=\"protyle-attr\" contenteditable=\"false\"></div></div>",
"id": "20220108003642-y2wmpcv",
"parentID": "20220107173950-7f9m1nb",
"previousID": "20220108003615-7rk41t1",
"retData": null
}
],
"undoOperations": null
}
]
}
action.data: 新しく挿入されたブロックによって生成されたDOMaction.id: 新しく挿入されたブロックのID/api/block/updateBlock
パラメータ
{
"dataType": "markdown",
"data": "foobarbaz",
"id": "20211230161520-querkps"
}
dataType: 更新するデータ型、markdownまたはdomdata: 更新するデータid: 更新するブロックのID戻り値
{
"code": 0,
"msg": "",
"data": [
{
"doOperations": [
{
"action": "update",
"data": "<div data-node-id=\"20211230161520-querkps\" data-node-index=\"1\" data-type=\"NodeParagraph\" class=\"p\"><div contenteditable=\"true\" spellcheck=\"false\">foo<strong>bar</strong>baz</div><div class=\"protyle-attr\" contenteditable=\"false\"></div></div>",
"id": "20211230161520-querkps",
"parentID": "",
"previousID": "",
"retData": null
}
],
"undoOperations": null
}
]
}
action.data: 更新されたブロックによって生成されたDOM/api/block/deleteBlock
パラメータ
{
"id": "20211230161520-querkps"
}
id: 削除するブロックのID戻り値
{
"code": 0,
"msg": "",
"data": [
{
"doOperations": [
{
"action": "delete",
"data": null,
"id": "20211230162439-vtm09qo",
"parentID": "",
"previousID": "",
"retData": null
}
],
"undoOperations": null
}
]
}
/api/block/moveBlock
パラメータ
{
"id": "20230406180530-3o1rqkc",
"previousID": "20230406152734-if5kyx6",
"parentID": "20230404183855-woe52ko"
}
id: 移動するブロックIDpreviousID: 前のブロックのID、挿入位置を固定するために使用parentID: 親ブロックのID、挿入位置を固定するために使用、previousIDとparentIDは同時に空にできない、両方存在する場合はpreviousIDが優先戻り値
{
"code": 0,
"msg": "",
"data": [
{
"doOperations": [
{
"action": "move",
"data": null,
"id": "20230406180530-3o1rqkc",
"parentID": "20230404183855-woe52ko",
"previousID": "20230406152734-if5kyx6",
"nextID": "",
"retData": null,
"srcIDs": null,
"name": "",
"type": ""
}
],
"undoOperations": null
}
]
}
/api/block/foldBlock
パラメータ
{
"id": "20231224160424-2f5680o"
}
id: 折りたたむブロックID戻り値
{
"code": 0,
"msg": "",
"data": null
}
/api/block/unfoldBlock
パラメータ
{
"id": "20231224160424-2f5680o"
}
id: 展開するブロックID戻り値
{
"code": 0,
"msg": "",
"data": null
}
/api/block/getBlockKramdown
パラメータ
{
"id": "20201225220954-dlgzk1o"
}
id: 取得するブロックのID戻り値
{
"code": 0,
"msg": "",
"data": {
"id": "20201225220954-dlgzk1o",
"kramdown": "* {: id=\"20201225220954-e913snx\"}Create a new notebook, create a new document under the notebook\n {: id=\"20210131161940-kfs31q6\"}\n* {: id=\"20201225220954-ygz217h\"}Enter <kbd>/</kbd> in the editor to trigger the function menu\n {: id=\"20210131161940-eo0riwq\"}\n* {: id=\"20201225220954-875yybt\"}((20200924101200-gss5vee \"Navigate in the content block\")) and ((20200924100906-0u4zfq3 \"Window and tab\"))\n {: id=\"20210131161940-b5uow2h\"}"
}
}
/api/block/getChildBlocks
パラメータ
{
"id": "20230506212712-vt9ajwj"
}
id: 親ブロックID戻り値
{
"code": 0,
"msg": "",
"data": [
{
"id": "20230512083858-mjdwkbn",
"type": "h",
"subType": "h1"
},
{
"id": "20230513213727-thswvfd",
"type": "s"
},
{
"id": "20230513213633-9lsj4ew",
"type": "l",
"subType": "u"
}
]
}
/api/block/transferBlockRef
パラメータ
{
"fromID": "20230612160235-mv6rrh1",
"toID": "20230613093045-uwcomng",
"refIDs": ["20230613092230-cpyimmd"]
}
fromID: 定義ブロックIDtoID: ターゲットブロックIDrefIDs: 定義ブロックIDを指す参照ブロックID、オプション、指定しない場合はすべての参照ブロックIDが移行される戻り値
{
"code": 0,
"msg": "",
"data": null
}
/api/attr/setBlockAttrs
パラメータ
{
"id": "20210912214605-uhi5gco",
"attrs": {
"custom-attr1": "line1\nline2"
}
}
id: ブロックIDattrs: ブロック属性、カスタム属性はcustom-プレフィックスが必要戻り値
{
"code": 0,
"msg": "",
"data": null
}
/api/attr/getBlockAttrs
パラメータ
{
"id": "20210912214605-uhi5gco"
}
id: ブロックID戻り値
{
"code": 0,
"msg": "",
"data": {
"custom-attr1": "line1\nline2",
"id": "20210912214605-uhi5gco",
"title": "PDF Annotation Demo",
"type": "doc",
"updated": "20210916120715"
}
}
/api/query/sql
パラメータ
{
"stmt": "SELECT * FROM blocks WHERE content LIKE'%content%' LIMIT 7"
}
stmt: SQL文戻り値
{
"code": 0,
"msg": "",
"data": [
{ "col": "val" }
]
}
注：データセキュリティを確保するため、パブリッシュモードでの本インターフェースへのアクセスは禁止されています。
/api/sqlite/flushTransaction
パラメータなし
戻り値
{
"code": 0,
"msg": "",
"data": null
}
/api/template/render
パラメータ
{
"id": "20220724223548-j6g0o87",
"path": "F:\\SiYuan\\data\\templates\\foo.md"
}
id: レンダリングが呼び出されるドキュメントのIDpath: テンプレートファイルの絶対パス戻り値
{
"code": 0,
"msg": "",
"data": {
"content": "<div data-node-id=\"20220729234848-dlgsah7\" data-node-index=\"1\" data-type=\"NodeParagraph\" class=\"p\" updated=\"20220729234840\"><div contenteditable=\"true\" spellcheck=\"false\">foo</div><div class=\"protyle-attr\" contenteditable=\"false\"></div></div>",
"path": "F:\\SiYuan\\data\\templates\\foo.md"
}
}
/api/template/renderSprig
パラメータ
{
"template": "/daily note/{{now | date \"2006/01\"}}/{{now | date \"2006-01-02\"}}"
}
template: テンプレートコンテンツ戻り値
{
"code": 0,
"msg": "",
"data": "/daily note/2023/03/2023-03-24"
}
/api/file/getFile
パラメータ
json { "path": "/data/20210808180117-6v0mkxr/20200923234011-ieuun1p.sy" }
path: ワークスペースパス配下のファイルパス戻り値
レスポンスステータスコード 200: ファイルコンテンツ
レスポンスステータスコード 202: 例外情報
{
"code": 404,
"msg": "",
"data": null
}
code: 0以外は例外
-1: パラメータ解析エラー403: アクセス拒否（ファイルがワークスペース内にない）404: 見つからない（ファイルが存在しない）405: メソッド不許可（ディレクトリである）500: サーバーエラー（ファイルのstat失敗 / ファイルの読み取り失敗）msg: エラーを説明するテキスト
/api/file/putFile
パラメータはHTTP Multipartフォーム
path: ワークスペースパス配下のファイルパスisDir: フォルダを作成するかどうか、trueの場合はフォルダのみ作成し、fileを無視modTime: 最終アクセス・更新時刻、Unix時間file: アップロードするファイル戻り値
{
"code": 0,
"msg": "",
"data": null
}
/api/file/removeFile
パラメータ
{
"path": "/data/20210808180117-6v0mkxr/20200923234011-ieuun1p.sy"
}
path: ワークスペースパス配下のファイルパス戻り値
{
"code": 0,
"msg": "",
"data": null
}
/api/file/renameFile
パラメータ
{
"path": "/data/assets/image-20230523085812-k3o9t32.png",
"newPath": "/data/assets/test-20230523085812-k3o9t32.png"
}
path: ワークスペースパス配下のファイルパスnewPath: ワークスペースパス配下の新しいファイルパス戻り値
{
"code": 0,
"msg": "",
"data": null
}
/api/file/readDir
パラメータ
{
"path": "/data/20210808180117-6v0mkxr/20200923234011-ieuun1p"
}
path: ワークスペースパス配下のディレクトリパス戻り値
{
"code": 0,
"msg": "",
"data": [
{
"isDir": true,
"isSymlink": false,
"name": "20210808180303-6yi0dv5",
"updated": 1691467624
},
{
"isDir": false,
"isSymlink": false,
"name": "20210808180303-6yi0dv5.sy",
"updated": 1663298365
}
]
}
/api/export/exportMdContent
パラメータ
{
"id": ""
}
id: エクスポートするドキュメントブロックのID戻り値
{
"code": 0,
"msg": "",
"data": {
"hPath": "/Please Start Here",
"content": "## 🍫 Content Block\n\nIn SiYuan, the only important core concept is..."
}
}
hPath: 人間が読めるパスcontent: Markdownコンテンツ/api/export/exportResources
パラメータ
{
"paths": [
"/conf/appearance/boot",
"/conf/appearance/langs",
"/conf/appearance/emojis/conf.json",
"/conf/appearance/icons/index.html"
],
"name": "zip-file-name"
}
paths: エクスポートするファイルまたはフォルダパスのリスト、同じファイル名/フォルダ名は上書きされるname: （オプション）エクスポートするファイル名、設定しない場合はデフォルトでexport-YYYY-MM-DD_hh-mm-ss.zip戻り値
{
"code": 0,
"msg": "",
"data": {
"path": "temp/export/zip-file-name.zip"
}
}
path: 作成された*.zipファイルのパス
zip-file-name.zip内のディレクトリ構造は以下の通り:
zip-file-name
bootlangsconf.jsonindex.html/api/convert/pandoc
作業ディレクトリ
workspace/temp/convert/pandoc/${dir}に設定されるファイルを配置を使用して、変換するファイルをこのディレクトリに先に書き込むことができるファイルを取得を呼び出して変換されたファイルを取得
importStdMdを呼び出して変換されたフォルダを直接インポートパラメータ
{
"dir": "test",
"args": [
"--to", "markdown_strict-raw_html",
"foo.epub",
"-o", "foo.md"
]
}
args: Pandocコマンドラインパラメータ戻り値
{
"code": 0,
"msg": "",
"data": {
"path": "/temp/convert/pandoc/test"
}
}
path: ワークスペース配下のパス/api/notification/pushMsg
パラメータ
{
"msg": "test",
"timeout": 7000
}
timeout: メッセージ表示時間（ミリ秒）。このフィールドは省略可能、デフォルトは7000ミリ秒戻り値
{
"code": 0,
"msg": "",
"data": {
"id": "62jtmqi"
}
}
id: メッセージID/api/notification/pushErrMsg
パラメータ
{
"msg": "test",
"timeout": 7000
}
timeout: メッセージ表示時間（ミリ秒）。このフィールドは省略可能、デフォルトは7000ミリ秒戻り値
{
"code": 0,
"msg": "",
"data": {
"id": "qc9znut"
}
}
id: メッセージID/api/network/forwardProxy
パラメータ
{
"url": "https://b3log.org/siyuan/",
"method": "GET",
"timeout": 7000,
"contentType": "text/html",
"headers": [
{
"Cookie": ""
}
],
"payload": {},
"payloadEncoding": "text",
"responseEncoding": "text"
}
url: 転送するURL
method: HTTPメソッド、デフォルトはPOST
timeout: タイムアウト（ミリ秒）、デフォルトは7000
contentType: Content-Type、デフォルトはapplication/json
headers: HTTPヘッダー
payload: HTTPペイロード、オブジェクトまたは文字列
payloadEncoding: payloadで使用されるエンコーディングスキーム、デフォルトはtext、選択可能な値は以下の通り
textbase64 | base64-stdbase64-urlbase32 | base32-stdbase32-hexhexresponseEncoding: レスポンスデータのbodyで使用されるエンコーディングスキーム、デフォルトはtext、選択可能な値は以下の通り
textbase64 | base64-stdbase64-urlbase32 | base32-stdbase32-hexhex戻り値
{
"code": 0,
"msg": "",
"data": {
"body": "",
"bodyEncoding": "text",
"contentType": "text/html",
"elapsed": 1976,
"headers": {
},
"status": 200,
"url": "https://b3log.org/siyuan"
}
}
bodyEncoding: bodyで使用されるエンコーディングスキーム、リクエストのresponseEncodingフィールドと一致、デフォルトはtext、選択可能な値は以下の通り
textbase64 | base64-stdbase64-urlbase32 | base32-stdbase32-hexhex/api/system/bootProgress
パラメータなし
戻り値
{
"code": 0,
"msg": "",
"data": {
"details": "Finishing boot...",
"progress": 100
}
}
/api/system/version
パラメータなし
戻り値
{
"code": 0,
"msg": "",
"data": "1.3.5"
}
/api/system/currentTime
パラメータなし
戻り値
{
"code": 0,
"msg": "",
"data": 1631850968131
}
data: ミリ秒精度