FastGPTFastGPT

Get Dataset Details

Retrieve full dataset configuration details including embedding, agent, and VLM models, sync state, and caller permissions.

Endpoint Overview

  • Method : GET
  • Path : /api/core/dataset/detail
  • 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/GET/core/dataset/detail )

Description & Notes

Retrieve full dataset configuration including model bindings, permissions, and synchronization status.

Request Parameters

Query Parameters

FieldTypeRequiredDefaultConstraints & Description
idstringYes-Dataset ID. pattern: ^[0-9a-fA-F]{24}$

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 GET "https://cloud.fastgpt.io/api/core/dataset/detail?id=68ad85a7463006c963799a05" \
  -H "Authorization: Bearer YOUR_API_KEY"

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 returned dataset details (omits createTime )

Content-Type : application/json

FieldTypeRequiredDefaultConstraints & Description
_idstringYes-Dataset ID. pattern: ^[0-9a-fA-F]{24}$
parentIdstring | nullNo-Parent folder ID
userIdstringNo-Deprecated . User ID. pattern: ^[0-9a-fA-F]{24}$
teamIdstringYes-Team ID. pattern: ^[0-9a-fA-F]{24}$
tmbIdstringYes-Team member ID. pattern: ^[0-9a-fA-F]{24}$
updateTimestringYes-Update time
inheritPermissionbooleanYes-Whether permissions are inherited from parent
collectionPermissionEnabledbooleanNo-Collection-level permission toggle ( false by default, inheriting dataset readability)
avatarstringYes"/icon/logo.svg"Avatar
namestringYes-Name
introstringYes-Introduction
typestring (enum)Yes-Dataset type. Allowed values: folder , dataset , websiteDataset , externalFile , apiDataset , feishu , yuque , dingtalk
vectorModelIdstringNo-Embedding model ID
agentModelIdstringNo-AI model ID
vlmModelIdstringNo-VLM model ID
websiteConfigobjectNo-Site sync configuration
websiteConfig.urlstringYes-Site URL
websiteConfig.selectorstringYes-CSS selector for site scraping
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 parse configuration
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 )
apiDatasetServerobjectNo-API dataset server configuration
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--
deleteTimestring | nullNo-Deletion timestamp
autoSyncbooleanNo-Auto-sync enabled
externalReadUrlstringNo-Deprecated . External source URL
defaultPermissionnumberNo-Deprecated . Default permission level
apiServerobjectNo-Deprecated . API dataset server configuration
apiServer.baseUrlstringYes--
apiServer.authorizationstringNo--
apiServer.basePathstringNo--
feishuServerobjectNo-Deprecated . Lark (Feishu) server configuration
feishuServer.appIdstringYes--
feishuServer.appSecretstringNo--
feishuServer.folderTokenstringYes--
yuqueServerobjectNo-Deprecated . Yuque server configuration
yuqueServer.userIdstringYes--
yuqueServer.tokenstringNo--
yuqueServer.basePathstringNo--
dingtalkServerobjectNo-Deprecated . DingTalk dataset configuration
dingtalkServer.appKeystringYes--
dingtalkServer.appSecretstringNo--
dingtalkServer.userIdstringYes--
dingtalkServer.operatorIdstringNo--
dingtalkServer.workspaceIdstringNo--
dingtalkServer.rootNodeIdstringNo--
dingtalkServer.workspaceNamestringNo--
statusstring (enum)Yes-Synchronization/training status. Allowed values: active , syncing , waiting , error
hasTrainingTaskbooleanYes-Whether active training jobs or pending/failed index/synonym rebuild tasks exist
errorMsgstringNo-Error details
vectorModelobjectNo-Embedding model details (empty if deleted; inactive models still return display metadata)
vectorModel.pricingobjectNo-Credit price per fixed billing unit; omitted if free
vectorModel.pricing.unitPricenumberNo-Composite credit price per million units (tokens/TTS) or per 60 seconds (STT). min: 0
vectorModel.providerstringYes-minLength: 1
vectorModel.modelstringYes-minLength: 1
vectorModel.namestringYes-minLength: 1
vectorModel.scopestring (enum)Yes"system"Allowed values: system , team
vectorModel.sortOrderintegerNo-Display rank within the same scope (smaller numbers appear first). min: 0; max: 9007199254740991
vectorModel.tmbIdstring | nullNo--
vectorModel.teamIdstring | nullNo--
vectorModel.isActivebooleanNo--
vectorModel.isUpcomingDeprecationbooleanNo-Whether the model is scheduled for deprecation
vectorModel.requestUrlstringNo--
vectorModel.requestAuthstringNo--
vectorModel.testModebooleanNo--
vectorModel.type"embedding"Yes-Fixed: "embedding"
vectorModel.configobjectYes--
vectorModel.config.defaultTokennumberYes--
vectorModel.config.maxTokennumberYes--
vectorModel.config.weightnumberYes0-
vectorModel.config.hiddenbooleanNo--
vectorModel.config.visionbooleanNo--
vectorModel.config.normalizationbooleanNo--
vectorModel.config.batchSizenumberNo--
vectorModel.config.defaultConfigobjectNo--
vectorModel.config.dbConfigobjectNo--
vectorModel.config.queryConfigobjectNo--
vectorModel.modelIdstringYes--
vectorModel.avatarstringNo--
agentModelobjectNo-AI model details (empty if deleted; inactive models still return display metadata)
agentModel.pricingobjectNo-Tiered LLM pricing per million tokens; omitted if free
agentModel.pricing.tiersobject[]No-LLM pricing tier (lower bound derives from the previous tier upper bound). maxItems: 5
agentModel.pricing.tiers[].maxInputTokensnumberNo-Upper input limit for this tier in million tokens; omit for unlimited. min: 0
agentModel.pricing.tiers[].inputPricenumberYes-Credit price per million input tokens. min: 0
agentModel.pricing.tiers[].outputPricenumberYes-Credit price per million output tokens. min: 0
agentModel.providerstringYes-minLength: 1
agentModel.modelstringYes-minLength: 1
agentModel.namestringYes-minLength: 1
agentModel.scopestring (enum)Yes"system"Allowed values: system , team
agentModel.sortOrderintegerNo-Display rank within the same scope (smaller numbers appear first). min: 0; max: 9007199254740991
agentModel.tmbIdstring | nullNo--
agentModel.teamIdstring | nullNo--
agentModel.isActivebooleanNo--
agentModel.isUpcomingDeprecationbooleanNo-Whether the model is scheduled for deprecation
agentModel.requestUrlstringNo--
agentModel.requestAuthstringNo--
agentModel.testModebooleanNo--
agentModel.type"llm"Yes-Fixed: "llm"
agentModel.configobjectYes--
agentModel.config.maxContextnumberYes--
agentModel.config.maxResponsenumberYes--
agentModel.config.quoteMaxTokennumberYes--
agentModel.config.maxTemperaturenumber | nullNo--
agentModel.config.showTopPbooleanNo--
agentModel.config.responseFormatListstring[]No--
agentModel.config.showStopSignbooleanNo--
agentModel.config.censorbooleanNo--
agentModel.config.visionbooleanNo--
agentModel.config.audiobooleanNo--
agentModel.config.videobooleanNo--
agentModel.config.reasoningbooleanNo--
agentModel.config.reasoningEffortbooleanNo--
agentModel.config.functionCallbooleanNo--
agentModel.config.toolChoicebooleanNo--
agentModel.config.defaultSystemChatPromptstringNo--
agentModel.config.defaultConfigobjectNo--
agentModel.config.fieldMapobjectNo--
agentModel.modelIdstringYes--
agentModel.avatarstringNo--
vlmModelobjectNo-Vision-Language Model (VLM)
vlmModel.pricingobjectNo-Tiered LLM pricing per million tokens; omitted if free
vlmModel.pricing.tiersobject[]No-LLM pricing tier (lower bound derives from the previous tier upper bound). maxItems: 5
vlmModel.pricing.tiers[].maxInputTokensnumberNo-Upper input limit for this tier in million tokens; omit for unlimited. min: 0
vlmModel.pricing.tiers[].inputPricenumberYes-Credit price per million input tokens. min: 0
vlmModel.pricing.tiers[].outputPricenumberYes-Credit price per million output tokens. min: 0
vlmModel.providerstringYes-minLength: 1
vlmModel.modelstringYes-minLength: 1
vlmModel.namestringYes-minLength: 1
vlmModel.scopestring (enum)Yes"system"Allowed values: system , team
vlmModel.sortOrderintegerNo-Display rank within the same scope (smaller numbers appear first). min: 0; max: 9007199254740991
vlmModel.tmbIdstring | nullNo--
vlmModel.teamIdstring | nullNo--
vlmModel.isActivebooleanNo--
vlmModel.isUpcomingDeprecationbooleanNo-Whether the model is scheduled for deprecation
vlmModel.requestUrlstringNo--
vlmModel.requestAuthstringNo--
vlmModel.testModebooleanNo--
vlmModel.type"llm"Yes-Fixed: "llm"
vlmModel.configobjectYes--
vlmModel.config.maxContextnumberYes--
vlmModel.config.maxResponsenumberYes--
vlmModel.config.quoteMaxTokennumberYes--
vlmModel.config.maxTemperaturenumber | nullNo--
vlmModel.config.showTopPbooleanNo--
vlmModel.config.responseFormatListstring[]No--
vlmModel.config.showStopSignbooleanNo--
vlmModel.config.censorbooleanNo--
vlmModel.config.visionbooleanNo--
vlmModel.config.audiobooleanNo--
vlmModel.config.videobooleanNo--
vlmModel.config.reasoningbooleanNo--
vlmModel.config.reasoningEffortbooleanNo--
vlmModel.config.functionCallbooleanNo--
vlmModel.config.toolChoicebooleanNo--
vlmModel.config.defaultSystemChatPromptstringNo--
vlmModel.config.defaultConfigobjectNo--
vlmModel.config.fieldMapobjectNo--
vlmModel.modelIdstringYes--
vlmModel.avatarstringNo--
permissionobjectYes-Serialized permission object JSON structure
permission.roleintegerYes-Permission role bitmask value. min: -9007199254740991; max: 9007199254740991
permission.isOwnerbooleanYes-Whether the caller has owner permission
permission.hasManagePerbooleanYes-Whether the caller has manage permission
permission.hasWritePerbooleanYes-Whether the caller has write permission
permission.hasReadPerbooleanYes-Whether the caller has read permission
permission.hasManageRolebooleanYes-Whether manage role bit is set
permission.hasWriteRolebooleanYes-Whether write role bit is set
permission.hasReadRolebooleanYes-Whether read role bit is set
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.