FastGPTFastGPT

Update Dataset

Update dataset name, introduction, model settings, website sync rules, PDF parse options, or move it to another folder.

Endpoint Overview

  • Method : PUT
  • Path : /api/core/dataset/update
  • Module : Datasets / Datasets
  • Authentication : Authorization: Bearer <apiKey>—Personal API Key (access scoped by team member permissions) (see API Getting Started )
  • Interactive Try-It-Out : Open in Scalar API Explorer (self-hosted instances: replace the origin with <instance>/apidoc/systemopenapi#tag/%E7%9F%A5%E8%AF%86%E5%BA%93%E7%AE%A1%E7%90%86/PUT/core/dataset/update )

Description & Notes

Update dataset metadata, model settings, sync configuration, or move it to another folder.

Request Parameters

Request Body ( application/json )

FieldTypeRequiredDefaultConstraints & Description
idstringYes-Dataset ID. pattern: ^[0-9a-fA-F]{24}$
parentIdstring | nullNo-Parent folder ID; pass null to move to the root directory
namestringNo-Dataset name
avatarstringNo-Dataset avatar URL
introstringNo-Dataset introduction
agentModelIdstringNo-Dataset Agent model ID; omitted leaves unchanged, cannot be cleared. minLength: 1
agentModelstringNo-Deprecated . Legacy dataset Agent model identifier; used only when agentModelId is omitted. minLength: 1
vlmModelIdstring | nullNo-VLM model ID; omitted leaves unchanged, null or empty string clears it
vlmModelstring | nullNo-Deprecated . Legacy VLM model identifier; used only when vlmModelId is omitted ( null or empty string clears it)
websiteConfigobjectNo-Site dataset configuration
websiteConfig.urlstringYes-Site URL
websiteConfig.selectorstringYes-CSS selector for site scraping
externalReadUrlstringNo-External source URL
apiDatasetServerobjectNo-Third-party dataset server configuration (API / Lark / Yuque / DingTalk)
apiDatasetServer.apiServerobjectNo-API dataset server configuration
apiDatasetServer.apiServer.baseUrlstringYes--
apiDatasetServer.apiServer.authorizationstringNo--
apiDatasetServer.apiServer.basePathstringNo--
apiDatasetServer.feishuServerobjectNo-Lark (Feishu) server configuration
apiDatasetServer.feishuServer.appIdstringYes--
apiDatasetServer.feishuServer.appSecretstringNo--
apiDatasetServer.feishuServer.folderTokenstringYes--
apiDatasetServer.yuqueServerobjectNo-Yuque server configuration
apiDatasetServer.yuqueServer.userIdstringYes--
apiDatasetServer.yuqueServer.tokenstringNo--
apiDatasetServer.yuqueServer.basePathstringNo--
apiDatasetServer.dingtalkServerobjectNo-DingTalk dataset configuration
apiDatasetServer.dingtalkServer.appKeystringYes--
apiDatasetServer.dingtalkServer.appSecretstringNo--
apiDatasetServer.dingtalkServer.userIdstringYes--
apiDatasetServer.dingtalkServer.operatorIdstringNo--
apiDatasetServer.dingtalkServer.workspaceIdstringNo--
apiDatasetServer.dingtalkServer.rootNodeIdstringNo--
apiDatasetServer.dingtalkServer.workspaceNamestringNo--
autoSyncbooleanNo-Whether auto-sync is enabled
chunkSettingsobjectNo-Chunking configuration
chunkSettings.trainingTypestring (enum)No-Training mode. Allowed values: chunk , qa , imageParse , backup , template , auto
chunkSettings.chunkTriggerTypestring (enum)No-Chunk trigger mode. Allowed values: minSize , forceChunk , maxSize
chunkSettings.chunkTriggerMinSizenumberNo-Minimum size threshold to trigger chunking
chunkSettings.dataEnhanceCollectionNamebooleanNo-Prepend collection name to chunks
chunkSettings.imageIndexbooleanNo-Enable image indexing
chunkSettings.autoIndexesbooleanNo-Auto-generate vector indexes
chunkSettings.indexPrefixTitlebooleanNo-Prefix title for indexes
chunkSettings.chunkSettingModestring (enum)No-Chunk setting preset ( auto , custom , or intelligent ). Allowed values: auto , custom , intelligent
chunkSettings.chunkSplitModestring (enum)No-Chunk splitting mode. Allowed values: paragraph , size , char
chunkSettings.paragraphChunkAIModestring (enum)No-AI paragraph chunking mode. Allowed values: auto , force , forbid
chunkSettings.paragraphChunkDeepnumberNo-Paragraph heading split depth
chunkSettings.paragraphChunkMinSizenumberNo-Minimum paragraph chunk size
chunkSettings.chunkSizenumberNo-Target chunk size
chunkSettings.chunkSplitterstringNo-Custom primary chunk separator
chunkSettings.indexSizenumberNo-Vector index chunk size
chunkSettings.qaPromptstringNo-Custom prompt for Q&A extraction
sangforFileParseConfigobjectNo-External PDF parsing switches (headers/footers, appendix, image OCR, chart-to-table); applies only to customPdfParse for newly parsed files
sangforFileParseConfig.keep_header_footerbooleanNo-Whether to keep page headers and footers (default false , strips headers/footers)
sangforFileParseConfig.keep_appendixbooleanNo-Whether to keep appendix sections (default true )
sangforFileParseConfig.image_analysisbooleanNo-Whether to retain OCR/image recognition results including stamps (default false )
sangforFileParseConfig.chart_analysisbooleanNo-Whether to keep chart-to-table extraction results alongside original images (default false )

Request Examples

Replace YOUR_API_KEY and placeholder IDs before running. Self-hosted users should replace the base URL with <instance>/api .

cURL Example

curl --fail-with-body -X PUT "https://cloud.fastgpt.io/api/core/dataset/update" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "id": "68ad85a7463006c963799a05"
}'

Minimal Valid JSON Body

{
  "id": "68ad85a7463006c963799a05"
}

Response Schema & Examples

Successful /api/* calls return the standard FastGPT envelope { "code": 200, "statusText": "", "message": "", "data": ... } , where data matches the 200 schema below (when a payload schema is declared; otherwise refer to the status description for runtime data semantics).

HTTP 200

Successfully updated dataset

Returns the standard FastGPT success envelope ( { "code": 200, "statusText": "", "message": "", "data": ... } ). The exact data payload schema is not declared in this OpenAPI contract; refer to the status description above or inspect runtime responses.

Edit on GitHub

Last updated

On this page

Put your business knowledge to work with AI

Import company documents and build accurate, reliable, traceable AI answers.