Get Collection Details
Retrieve collection metadata, source file info, chunk and training status counts, and effective caller permissions.
Endpoint Overview
- Method :
GET - Path :
/api/core/dataset/collection/detail - Module : Datasets / 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%E7%AE%A1%E7%90%86/GET/core/dataset/collection/detail)
Description & Notes
Retrieve detailed collection metadata including index counts, error counts, and file details (requires dataset and collection read access).
Request Parameters
Query Parameters
| Field | Type | Required | Default | Constraints & Description |
|---|---|---|---|---|
id | string | Yes | - | Collection ID |
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/collection/detail?id=string" \
-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 collection details
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.
Last updated