scope

String

Yes

Markdown download range

• doc

doc_id

Number

Yes

VeRAG document ID, doc mode required

page_size

Number

No

The page size of the top-level document downloaded by the entire library

page_token

Number

No

Whole library download cursor

include_import_params

Boolean

No

Whether to return reimport parameters

code

Number

Yes

Response code: 0 = success, non-0 = failure

msg

String

No

Code is not 0, error message is returned

message

String

No

error message

data

Object

Yes

Data, see the data table below for details

scope

String

Yes

Markdown download range

• doc
• library

items

Array

No

List of root documents, see the items table below

total_count

Number

No

Total number of top-level documents

success_count

Number

No

The number of downloadable nodes in the current tree

next_page_token

Number

No

Next page cursor

has_more

Boolean

No

Is there a next page?

total_doc_count

Number

No

Total number of documents with subdocuments

returned_doc_count

Number

No

Current number of responding nodes

doc_id

Number

Yes

Mainboard document ID with values for all recursive nodes

verag_doc_id

Number

No

VeRAG document ID; returned when local mapping only exists

task_id

Number

No

Import Task ID

status

String

Yes

Markdown downloadable state for a single Mainboard entry, rather than execution results for the entire RPC.

• OK
• NOT_READY
• NOT_FOUND
• FAILED

reason

String

No

Reason for not downloading

download_url

String

No

Directly accessible download address

expire_at

Number

No

Download address expires timestamp

file_metadata

Object

No

File metadata, see file_metadata table below

import_params

Object

No

Reimport parameters, see import_params table below

import_params_reason

String

No

Reason for missing reimport parameters

parent_entry_id

Number

No

Mainboard entry ID

direct_child_count

Number

No

number of direct subdocuments

descendant_count

Number

No

Number of subdocuments at all levels

children

Array

No

Recursive subdocuments, support recursive configuration of items parameters

original_file_name

String

No

original file name

markdown_file_name

String

No

Markdown file name

doc_type

String

No

document type

source

String

No

import source

markdown_object_key

String

No

Markdown object metadata path

metadata_source

String

No

Object key source

content_type

String

No

content type

create_time

Number

No

Create timestamp

modify_time

Number

No

Modify timestamp

import_settings

String

No

Import configuration JSON

chunk_settings

String

No

split configuration JSON

tags

Array

No

Reimport tags, see the tags table below for details

key

String

No

Label key

field

String

No

label field

value

Array

No

label value