FastGPTFastGPT

Get Collection Citation Chunks

Paginate forward and backward around a cited chunk index inside a referenced dataset collection during chat inspection.

Endpoint Overview

  • Method : POST
  • Path : /api/core/chat/record/getCollectionQuote
  • Module : Chat / Chat Records
  • Authentication : Authorization: Bearer <apiKey>—Supports App API Key ( appId optional) and Personal API Key ( appId required); also supports authProxy team member proxy and outLinkAuthData share link (see API Getting Started )
  • Interactive Try-It-Out : Open in Scalar API Explorer (self-hosted instances: replace the origin with <instance>/apidoc/systemopenapi#tag/%E5%AF%B9%E8%AF%9D%E7%AE%A1%E7%90%86/POST/core/chat/record/getCollectionQuote )

Description & Notes

Paginate forward or backward around a cited chunk index inside a collection (requires chat access).

Request Parameters

Request Body ( application/json )

Shared Parameters Across Branches

FieldTypeRequiredDefaultConstraints & Description
chatIdstringYes-Chat ID. minLength: 1; maxLength: 1024
chatItemDataIdstringYes-Chat message dataId . minLength: 1; maxLength: 256
collectionIdstringYes-Collection ID. pattern: ^[0-9a-fA-F]{24}$
pageSizeintegerNo20Items per page (default 20, range [1, 30] ). min: 1; max: 30
anchornumberNo-Current anchor chunkIndex
initialIdstringNo-Initial anchor message data ID
nextIdstringNo-Cursor data ID for paging forward
prevIdstringNo-Cursor data ID for paging backward

Mutually Exclusive Branches ( anyOf )

  • App Chat

Identify the conversation via appId . When both API Key and login session are supported, Authorization takes precedence over token/Cookie.

FieldTypeRequiredDefaultConstraints & Description
appIdstringYes-Application ID authenticated with the request header credentials allowed by this endpoint. pattern: ^[0-9a-fA-F]{24}$
sourceTypestring (enum)No-Session resource type associated with appId . Defaults to app ; pass the matching sourceType for assistant builder sessions. Allowed values: app , chatAgentHelper , workflowBuilder

Default Identity : Omit customUid and authProxy to execute using the team member identity associated with the credential.

Custom end user ( customUid ): Tag end users from your own system via customUid without changing the authenticating member or permissions. Passed as workflow userId and used to scope chat management.

FieldTypeRequiredDefaultConstraints & Description
customUidstringYes-Supported only for standard app API Key calls. Exact match against the external user ID ( outLinkUid , not tmbId ). Omit to keep full scope or pass to restrict reads, updates, and deletions (max 1024 chars, cannot be empty or null , does not change member identity). minLength: 1; maxLength: 1024

Proxy Team Member ( authProxy ): Act on behalf of another member in the same team via authProxy . Available only on personal API keys with authProxy enabled; mutually exclusive with customUid .

FieldTypeRequiredDefaultConstraints & Description
authProxyobjectYes-API Key proxy caller identity. Available only for personal keys with authProxy enabled; specify tmbId or username ( tmbId takes precedence without falling back to username on invalid ID).
authProxy.tmbIdstringYes-Branch: By Team Member ID . Proxied team member ID ( tmbId ), takes precedence over username . pattern: ^[0-9a-fA-F]{24}$
authProxy.usernamestringYes-Branch: By Username . Proxied team member username. minLength: 1; maxLength: 128
  • Skill Debug Session

Identify the debug session via skillId (takes precedence over appId and ignores sourceType ), authenticated with allowed request header credentials.

FieldTypeRequiredDefaultConstraints & Description
skillIdstringYes-Skill Edit debug ID authenticated with allowed request header credentials. pattern: ^[0-9a-fA-F]{24}$
  • Share-Link Chat

Resolves the underlying app via outLinkAuthData , taking precedence over skillId and appId (ignoring sourceType ). Protected links still validate login cookies/tokens and never fall back to standard auth on failure.

FieldTypeRequiredDefaultConstraints & Description
outLinkAuthDataobjectYes-Share-link auth payload ( shareId / outLinkUid ). Overrides skillId and appId ; protected links still validate login session cookies/tokens.
outLinkAuthData.shareIdstringYes-Share link ID. minLength: 1
outLinkAuthData.outLinkUidstringYes-External share user ID. minLength: 1
  • App API Key (no appId required)

When authorizing with an app-bound App API Key, omit appId and sourceType ; the server resolves the bound app with sourceType fixed to app . Personal keys and login sessions cannot omit appId , and an explicit appId does not override an App API Key binding.

Default Identity : Omit customUid and authProxy to execute using the team member identity associated with the credential.

Custom end user ( customUid ): Tag end users from your own system via customUid without changing the authenticating member or permissions. Passed as workflow userId and used to scope chat management.

FieldTypeRequiredDefaultConstraints & Description
customUidstringYes-Supported only for standard app API Key calls. Exact match against the external user ID ( outLinkUid , not tmbId ). Omit to keep full scope or pass to restrict reads, updates, and deletions (max 1024 chars, cannot be empty or null , does not change member identity). minLength: 1; maxLength: 1024

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/chat/record/getCollectionQuote" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "appId": "68ad85a7463006c963799a05",
  "chatId": "string",
  "chatItemDataId": "item_abc123",
  "collectionId": "68ee0bd23d17260b7829b137"
}'

Minimal Valid JSON Body

{
  "appId": "68ad85a7463006c963799a05",
  "chatId": "string",
  "chatItemDataId": "item_abc123",
  "collectionId": "68ee0bd23d17260b7829b137"
}

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 paginated collection chunks

Content-Type : application/json

FieldTypeRequiredDefaultConstraints & Description
listobject[]Yes--
list[]._idstringYes-Data item ID. pattern: ^[0-9a-fA-F]{24}$
list[].qstringYes-Primary chunk content / question
list[].astringNo-Supplementary answer / text
list[].imagePreivewUrlstringNo-Image preview URL
list[].historyobject[]No-Legacy snapshot flag
list[].history[].qstringYes-Primary chunk content / question
list[].history[].astringNo-Supplementary answer / text
list[].history[].imageIdstringNo-Image ID
list[].history[].updateTimestringYes-Update time
list[].updateTimestringYes-Update time
list[].indexintegerYes-Chunk index. min: 0; max: 9007199254740991
list[].updatedbooleanNo-Whether the chunk has been updated since citation
list[].idstringYes-Data ID (alias of _id )
list[].anchornumberNo-Chunk sequence index (alias of index )
hasMorePrevbooleanYes-Whether earlier messages exist before the current slice
hasMoreNextbooleanYes-Whether newer messages exist after the current slice
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.