FastGPTFastGPT

Create Collection from Local File

Upload a local file via multipart/form-data with chunking and training settings to create a collection and start indexing.

Endpoint Overview

  • Method : POST
  • Path : /api/core/dataset/collection/create/localFile
  • Module : Datasets / Create Collections
  • 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/%E9%9B%86%E5%90%88%E5%88%9B%E5%BB%BA/POST/core/dataset/collection/create/localFile )

Description & Notes

Upload a local file via multipart/form-data ( file binary part + JSON-serialized data part), store it in S3, create the collection, and trigger training.

Request Parameters

Request Body ( multipart/form-data )

FieldTypeRequiredDefaultConstraints & Description
filebinary (file)Yes-Uploaded binary file
dataobjectYes-Collection parameters passed as a serialized JSON string
data.trainingTypestring (enum)No-Training mode. Allowed values: chunk , qa , imageParse , backup , template , auto
data.chunkTriggerTypestring (enum)No-Chunk trigger mode. Allowed values: minSize , forceChunk , maxSize
data.chunkTriggerMinSizenumberNo-Minimum size threshold to trigger chunking
data.dataEnhanceCollectionNamebooleanNo-Prepend collection name to chunks
data.imageIndexbooleanNo-Enable image indexing
data.autoIndexesbooleanNo-Auto-generate vector indexes
data.indexPrefixTitlebooleanNo-Prefix title for indexes
data.chunkSettingModestring (enum)No-Chunk setting preset ( auto , custom , or intelligent ). Allowed values: auto , custom , intelligent
data.chunkSplitModestring (enum)No-Chunk splitting mode. Allowed values: paragraph , size , char
data.paragraphChunkAIModestring (enum)No-AI paragraph chunking mode. Allowed values: auto , force , forbid
data.paragraphChunkDeepnumberNo-Paragraph heading split depth
data.paragraphChunkMinSizenumberNo-Minimum paragraph chunk size
data.chunkSizenumberNo-Target chunk size
data.chunkSplitterstringNo-Custom primary chunk separator
data.indexSizenumberNo-Vector index chunk size
data.qaPromptstringNo-Custom prompt for Q&A extraction
data.parentIdstring | nullNo-Parent folder ID
data.metadataobjectNo-Metadata
data.customPdfParsebooleanNo-Custom PDF parser
data.datasetIdstringYes-Dataset ID
data.tagsstring | object[]No-List of collection tags. String items map to legacy default_tag tags; object items { tag, value } resolve by tag name.

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 POST "https://cloud.fastgpt.io/api/core/dataset/collection/create/localFile" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@/path/to/document.pdf" \
  -F 'data={"datasetId":"string"};type=application/json'

Minimal Valid JSON Body

{
  "datasetId": "string"
}

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 collection ID and chunk insertion results

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.