FastGPTFastGPT

Create Collection from Text

Store raw text or Markdown content as a dataset collection and trigger asynchronous chunking and embedding training.

Endpoint Overview

  • Method : POST
  • Path : /api/core/dataset/collection/create/text
  • 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/text )

Description & Notes

Store raw text content as a file, create a collection, and trigger indexing training.

Request Parameters

Request Body ( application/json )

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

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/text" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "datasetId": "string",
  "name": "string",
  "text": "string"
}'

Minimal Valid JSON Body

{
  "datasetId": "string",
  "name": "string",
  "text": "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.