Prompt file imported from hduhelp/AcademicSupportSystem (.github/prompts/fastgpt.prompt.md). Copyright stays with the author.

openapi: 3.0.0 info: title: FastGPT Open Source API description: > API documentation for FastGPT non-commercial features.

**Base URL Note**: The BaseURL is the root address for all interfaces (e.g., `https://api.fastgpt.in/api`).

**Authentication**:
All interfaces require the `Authorization` header.
- **App-specific Key**: Used for Chat Completion interfaces (starts with `fastgpt-`).
- **Global Key**: Used for management interfaces (dataset, app management, etc.).

version: 4.8.x servers:

url: http://localhost:3000/api description: Local development environment
url: https://api.fastgpt.in/api description: Official SaaS (Example) components: securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: API Key schemas: ChatCompletionRequest: type: object required: - messages properties: chatId: type: string description: Chat ID. If provided, history is used/stored. If empty, it's a stateless conversation. stream: type: boolean default: false description: Whether to stream the response. detail: type: boolean default: false description: Whether to return detailed execution information (module status, references, etc.). variables: type: object description: Module variables to replace [key] in inputs. messages: type: array items: type: object properties: role: type: string enum: [user, assistant, system] content: type: string description: Text content. (For vision/files, use array structure as per OpenAI spec).

ChatResponse: type: object properties: id: type: string choices: type: array items: type: object properties: message: type: object properties: role: type: string content: type: string finish_reason: type: string

DatasetCreateRequest: type: object required: - name properties: parentId: type: string nullable: true description: Parent folder ID. type: type: string enum: [dataset, folder] default: dataset name: type: string intro: type: string avatar: type: string vectorModel: type: string description: Vector model name (leave empty for system default). agentModel: type: string description: QA generation model (leave empty for system default).

security:

BearerAuth: []

paths:

============================

Name: fastgpt-api
Author: hduhelp

Chat Interface

============================

/v1/chat/completions: post: summary: Chat Completion (Standard & Workflow) description: > Compatible with OpenAI Chat Completion API. Requires App-specific Key. tags: - Chat requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ChatCompletionRequest' responses: '200': description: Chat response (stream or json) content: application/json: schema: $ref: '#/components/schemas/ChatResponse' text/event-stream: schema: type: string description: Server-Sent Events stream

============================

Chat History Management

============================

/core/chat/history/getHistories: post: summary: Get Chat History List tags: - Chat History requestBody: content: application/json: schema: type: object properties: appId: type: string offset: type: integer default: 0 pageSize: type: integer default: 20 source: type: string enum: [api] description: "Filter by source (e.g. 'api' for API-created chats)" responses: '200': description: List of chat sessions

/core/chat/history/updateHistory: post: summary: Update Chat Session (Title/Top) tags: - Chat History requestBody: content: application/json: schema: type: object required: - appId - chatId properties: appId: type: string chatId: type: string customTitle: type: string description: Rename the chat session top: type: boolean description: Pin or unpin the chat responses: '200': description: Success

/core/chat/history/delHistory: delete: summary: Delete a Chat Session tags: - Chat History parameters: - name: appId in: query required: true schema: type: string - name: chatId in: query required: true schema: type: string responses: '200': description: Success

/core/chat/getPaginationRecords: post: summary: Get Records within a Chat Session tags: - Chat History requestBody: content: application/json: schema: type: object required: - appId - chatId properties: appId: type: string chatId: type: string offset: type: integer pageSize: type: integer loadCustomFeedbacks: type: boolean responses: '200': description: List of messages in the session

============================

Dataset (Knowledge Base)

============================

/core/dataset/create: post: summary: Create Dataset tags: - Dataset requestBody: content: application/json: schema: $ref: '#/components/schemas/DatasetCreateRequest' responses: '200': description: Dataset ID returned

/core/dataset/list: post: summary: List Datasets tags: - Dataset requestBody: content: application/json: schema: type: object properties: parentId: type: string nullable: true description: Pass null or empty string for root. responses: '200': description: List of datasets

/core/dataset/detail: get: summary: Get Dataset Details tags: - Dataset parameters: - name: id in: query required: true schema: type: string responses: '200': description: Dataset detail object

/core/dataset/delete: delete: summary: Delete Dataset tags: - Dataset parameters: - name: id in: query required: true schema: type: string responses: '200': description: Success

============================

Dataset Collection (Files/Data)

============================

/core/dataset/collection/create/text: post: summary: Create Collection from Text tags: - Dataset Collection requestBody: content: application/json: schema: type: object required: - text - datasetId - name - trainingType properties: text: type: string datasetId: type: string name: type: string trainingType: type: string enum: [chunk, qa] chunkSettingMode: type: string enum: [auto, custom] responses: '200': description: Collection creation result

/core/dataset/collection/create/link: post: summary: Create Collection from URL tags: - Dataset Collection requestBody: content: application/json: schema: type: object required: - link - datasetId - trainingType properties: link: type: string datasetId: type: string trainingType: type: string enum: [chunk, qa] metadata: type: object properties: webPageSelector: type: string description: CSS selector to extract content responses: '200': description: Collection creation result

/core/dataset/data/pushData: post: summary: Push Data to Collection description: Manually insert Q&A or text data into a collection. tags: - Dataset Data requestBody: content: application/json: schema: type: object required: - collectionId - data properties: collectionId: type: string trainingType: type: string enum: [chunk, qa] data: type: array items: type: object required: - q properties: q: type: string description: Main content / Question a: type: string description: Auxiliary content / Answer indexes: type: array items: type: object properties: text: type: string responses: '200': description: Insertion result

/core/dataset/searchTest: post: summary: Search Test tags: - Dataset Data requestBody: content: application/json: schema: type: object required: - datasetId - text properties: datasetId: type: string text: type: string limit: type: integer default: 3000 similarity: type: number default: 0 searchMode: type: string enum: [embedding, fullTextReRank] responses: '200': description: Search results

============================

Share Link Identity

============================

/shareAuth/init: post: summary: Share Link Auth Init (User Defined) description: This is an interface YOU implement on your server, not a FastGPT API. FastGPT calls this hook. tags: - Share Auth Hooks requestBody: content: application/json: schema: type: object properties: token: type: string responses: '200': description: Returns success and uid

/shareAuth/start: post: summary: Share Link Auth Start (User Defined) description: Hook called before chat starts. tags: - Share Auth Hooks requestBody: content: application/json: schema: type: object properties: token: type: string question: type: string responses: '200': description: Returns success status

/shareAuth/finish: post: summary: Share Link Auth Finish (User Defined) description: Hook called after chat finishes (for billing/logging). tags: - Share Auth Hooks requestBody: content: application/json: schema: type: object properties: token: type: string responseData: type: array items: type: object responses: '200': description: Acknowledge receipt

openapi: 3.0.0 info: title: FastGPT Open Source API description: > API documentation for FastGPT non-commercial features. **Base URL Note**: The BaseURL is the root address for all interfaces (e.g., `https://api.fastgpt.in/api`). **Authentication**: All interfaces require the `Authorization` header. - **App-specific Key**: Used for Chat Completion interfaces (starts with `fastgpt-`). - **Global Key**: Used for management interfaces (dataset, app management, etc.). version: 4.8.x servers: - url: http://localhost:3000/api description: Local development environment - url: https://api.fastgpt.in/api description: Official SaaS (Example) components: securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: API Key schemas: ChatCompletionRequest: type: object required: - messages properties: chatId: type: string description: Chat ID. If provided, history is used/stored. If empty, it's a stateless conversation. stream: type: boolean default: false description: Whether to stream the response. detail: type: boolean default: false description: Whether to return detailed execution information (module status, references, etc.). variables: type: object description: Module variables to replace `[key]` in inputs. messages: type: array items: type: object properties: role: type: string enum: [user, assistant, system] content: type: string description: Text content. (For vision/files, use array structure as per OpenAI spec). ChatResponse: type: object properties: id: type: string choices: type: array items: type: object properties: message: type: object properties: role: type: string content: type: string finish_reason: type: string DatasetCreateRequest: type: object required: - name properties: parentId: type: string nullable: true description: Parent folder ID. type: type: string enum: [dataset, folder] default: dataset name: type: string intro: type: string avatar: type: string vectorModel: type: string description: Vector model name (leave empty for system default). agentModel: type: string description: QA generation model (leave empty for system default). security: - BearerAuth: [] paths: # ============================ # Chat Interface # ============================ /v1/chat/completions: post: summary: Chat Completion (Standard & Workflow) description: > Compatible with OpenAI Chat Completion API. Requires **App-specific Key**. tags: - Chat requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ChatCompletionRequest' responses: '200': description: Chat response (stream or json) content: application/json: schema: $ref: '#/components/schemas/ChatResponse' text/event-stream: schema: type: string description: Server-Sent Events stream # ============================ # Chat History Management # ============================ /core/chat/history/getHistories: post: summary: Get Chat History List tags: - Chat History requestBody: content: application/json: schema: type: object properties: appId: type: string offset: type: integer default: 0 pageSize: type: integer default: 20 source: type: string enum: [api] description: "Filter by source (e.g. 'api' for API-created chats)" responses: '200': description: List of chat sessions /core/chat/history/updateHistory: post: summary: Update Chat Session (Title/Top) tags: - Chat History requestBody: content: application/json: schema: type: object required: - appId - chatId properties: appId: type: string chatId: type: string customTitle: type: string description: Rename the chat session top: type: boolean description: Pin or unpin the chat responses: '200': description: Success /core/chat/history/delHistory: delete: summary: Delete a Chat Session tags: - Chat History parameters: - name: appId in: query required: true schema: type: string - name: chatId in: query required: true schema: type: string responses: '200': description: Success /core/chat/getPaginationRecords: post: summary: Get Records within a Chat Session tags: - Chat History requestBody: content: application/json: schema: type: object required: - appId - chatId properties: appId: type: string chatId: type: string offset: type: integer pageSize: type: integer loadCustomFeedbacks: type: boolean responses: '200': description: List of messages in the session # ============================ # Dataset (Knowledge Base) # ============================ /core/dataset/create: post: summary: Create Dataset tags: - Dataset requestBody: content: application/json: schema: $ref: '#/components/schemas/DatasetCreateRequest' responses: '200': description: Dataset ID returned /core/dataset/list: post: summary: List Datasets tags: - Dataset requestBody: content: application/json: schema: type: object properties: parentId: type: string nullable: true description: Pass null or empty string for root. responses: '200': description: List of datasets /core/dataset/detail: get: summary: Get Dataset Details tags: - Dataset parameters: - name: id in: query required: true schema: type: string responses: '200': description: Dataset detail object /core/dataset/delete: delete: summary: Delete Dataset tags: - Dataset parameters: - name: id in: query required: true schema: type: string responses: '200': description: Success # ============================ # Dataset Collection (Files/Data) # ============================ /core/dataset/collection/create/text: post: summary: Create Collection from Text tags: - Dataset Collection requestBody: content: application/json: schema: type: object required: - text - datasetId - name - trainingType properties: text: type: string datasetId: type: string name: type: string trainingType: type: string enum: [chunk, qa] chunkSettingMode: type: string enum: [auto, custom] responses: '200': description: Collection creation result /core/dataset/collection/create/link: post: summary: Create Collection from URL tags: - Dataset Collection requestBody: content: application/json: schema: type: object required: - link - datasetId - trainingType properties: link: type: string datasetId: type: string trainingType: type: string enum: [chunk, qa] metadata: type: object properties: webPageSelector: type: string description: CSS selector to extract content responses: '200': description: Collection creation result /core/dataset/data/pushData: post: summary: Push Data to Collection description: Manually insert Q&A or text data into a collection. tags: - Dataset Data requestBody: content: application/json: schema: type: object required: - collectionId - data properties: collectionId: type: string trainingType: type: string enum: [chunk, qa] data: type: array items: type: object required: - q properties: q: type: string description: Main content / Question a: type: string description: Auxiliary content / Answer indexes: type: array items: type: object properties: text: type: string responses: '200': description: Insertion result /core/dataset/searchTest: post: summary: Search Test tags: - Dataset Data requestBody: content: application/json: schema: type: object required: - datasetId - text properties: datasetId: type: string text: type: string limit: type: integer default: 3000 similarity: type: number default: 0 searchMode: type: string enum: [embedding, fullTextReRank] responses: '200': description: Search results # ============================ # Share Link Identity # ============================ /shareAuth/init: post: summary: Share Link Auth Init (User Defined) description: This is an interface YOU implement on your server, not a FastGPT API. FastGPT calls this hook. tags: - Share Auth Hooks requestBody: content: application/json: schema: type: object properties: token: type: string responses: '200': description: Returns success and uid /shareAuth/start: post: summary: Share Link Auth Start (User Defined) description: Hook called before chat starts. tags: - Share Auth Hooks requestBody: content: application/json: schema: type: object properties: token: type: string question: type: string responses: '200': description: Returns success status /shareAuth/finish: post: summary: Share Link Auth Finish (User Defined) description: Hook called after chat finishes (for billing/logging). tags: - Share Auth Hooks requestBody: content: application/json: schema: type: object properties: token: type: string responseData: type: array items: type: object responses: '200': description: Acknowledge receipt

{ "prompt": "openapi: 3.0.0\ninfo:\n title: FastGPT Open Source API\n description: >\n API documentation for FastGPT non-commercial features.\n \n **Base URL Note**: The BaseURL is the root address for all interfaces (e.g., `https://api.fastgpt.in/api`).\n \n **Authentication**:\n All interfaces require the `Authorization` header.\n - **App-specific Key**: Used for Chat Completion interfaces (starts with `fastgpt-`).\n - **Global Key**: Used for management interfaces (dataset, app management, etc.).\n version: 4.8.x\nservers:\n - url: http://localhost:3000/api\n description: Local development environment\n - url: https://api.fastgpt.in/api\n description: Official SaaS (Example)\ncomponents:\n securitySchemes:\n BearerAuth:\n type: http\n scheme: bearer\n bearerFormat: API Key\n schemas:\n ChatCompletionRequest:\n type: object\n required:\n - messages\n properties:\n chatId:\n type: string\n description: Chat ID. If provided, history is used/stored. If empty, it's a stateless conversation.\n stream:\n type: boolean\n default: false\n description: Whether to stream the response.\n detail:\n type: boolean\n default: false\n description: Whether to return detailed execution information (module status, references, etc.).\n variables:\n type: object\n description: Module variables to replace `[key]` in inputs.\n messages:\n type: array\n items:\n type: object\n properties:\n role:\n type: string\n enum: [user, assistant, system]\n content:\n type: string\n description: Text content. (For vision/files, use array structure as per OpenAI spec).\n \n ChatResponse:\n type: object\n properties:\n id:\n type: string\n choices:\n type: array\n items:\n type: object\n properties:\n message:\n type: object\n properties:\n role:\n type: string\n content:\n type: string\n finish_reason:\n type: string\n \n DatasetCreateRequest:\n type: object\n required:\n - name\n properties:\n parentId:\n type: string\n nullable: true\n description: Parent folder ID.\n type:\n type: string\n enum: [dataset, folder]\n default: dataset\n name:\n type: string\n intro:\n type: string\n avatar:\n type: string\n vectorModel:\n type: string\n description: Vector model name (leave empty for system default).\n agentModel:\n type: string\n description: QA generation model (leave empty for system default).\n\nsecurity:\n - BearerAuth: []\n\npaths:\n # ============================\n # Chat Interface\n # ============================\n /v1/chat/completions:\n post:\n summary: Chat Completion (Standard & Workflow)\n description: >\n Compatible with OpenAI Chat Completion API.\n Requires **App-specific Key**.\n tags:\n - Chat\n requestBody:\n required: true\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ChatCompletionRequest'\n responses:\n '200':\n description: Chat response (stream or json)\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ChatResponse'\n text/event-stream:\n schema:\n type: string\n description: Server-Sent Events stream\n\n # ============================\n # Chat History Management\n # ============================\n /core/chat/history/getHistories:\n post:\n summary: Get Chat History List\n tags:\n - Chat History\n requestBody:\n content:\n application/json:\n schema:\n type: object\n properties:\n appId:\n type: string\n offset:\n type: integer\n default: 0\n pageSize:\n type: integer\n default: 20\n source:\n type: string\n enum: [api]\n description: \"Filter by source (e.g. 'api' for API-created chats)\"\n responses:\n '200':\n description: List of chat sessions\n \n /core/chat/history/updateHistory:\n post:\n summary: Update Chat Session (Title/Top)\n tags:\n - Chat History\n requestBody:\n content:\n application/json:\n schema:\n type: object\n required:\n - appId\n - chatId\n properties:\n appId:\n type: string\n chatId:\n type: string\n customTitle:\n type: string\n description: Rename the chat session\n top:\n type: boolean\n description: Pin or unpin the chat\n responses:\n '200':\n description: Success\n\n /core/chat/history/delHistory:\n delete:\n summary: Delete a Chat Session\n tags:\n - Chat History\n parameters:\n - name: appId\n in: query\n required: true\n schema:\n type: string\n - name: chatId\n in: query\n required: true\n schema:\n type: string\n responses:\n '200':\n description: Success\n\n /core/chat/getPaginationRecords:\n post:\n summary: Get Records within a Chat Session\n tags:\n - Chat History\n requestBody:\n content:\n application/json:\n schema:\n type: object\n required:\n - appId\n - chatId\n properties:\n appId:\n type: string\n chatId:\n type: string\n offset:\n type: integer\n pageSize:\n type: integer\n loadCustomFeedbacks:\n type: boolean\n responses:\n '200':\n description: List of messages in the session\n\n # ============================\n # Dataset (Knowledge Base)\n # ============================\n /core/dataset/create:\n post:\n summary: Create Dataset\n tags:\n - Dataset\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/DatasetCreateRequest'\n responses:\n '200':\n description: Dataset ID returned\n\n /core/dataset/list:\n post:\n summary: List Datasets\n tags:\n - Dataset\n requestBody:\n content:\n application/json:\n schema:\n type: object\n properties:\n parentId:\n type: string\n nullable: true\n description: Pass null or empty string for root.\n responses:\n '200':\n description: List of datasets\n\n /core/dataset/detail:\n get:\n summary: Get Dataset Details\n tags:\n - Dataset\n parameters:\n - name: id\n in: query\n required: true\n schema:\n type: string\n responses:\n '200':\n description: Dataset detail object\n\n /core/dataset/delete:\n delete:\n summary: Delete Dataset\n tags:\n - Dataset\n parameters:\n - name: id\n in: query\n required: true\n schema:\n type: string\n responses:\n '200':\n description: Success\n\n # ============================\n # Dataset Collection (Files/Data)\n # ============================\n /core/dataset/collection/create/text:\n post:\n summary: Create Collection from Text\n tags:\n - Dataset Collection\n requestBody:\n content:\n application/json:\n schema:\n type: object\n required:\n - text\n - datasetId\n - name\n - trainingType\n properties:\n text:\n type: string\n datasetId:\n type: string\n name:\n type: string\n trainingType:\n type: string\n enum: [chunk, qa]\n chunkSettingMode:\n type: string\n enum: [auto, custom]\n responses:\n '200':\n description: Collection creation result\n\n /core/dataset/collection/create/link:\n post:\n summary: Create Collection from URL\n tags:\n - Dataset Collection\n requestBody:\n content:\n application/json:\n schema:\n type: object\n required:\n - link\n - datasetId\n - trainingType\n properties:\n link:\n type: string\n datasetId:\n type: string\n trainingType:\n type: string\n enum: [chunk, qa]\n metadata:\n type: object\n properties:\n webPageSelector:\n type: string\n description: CSS selector to extract content\n responses:\n '200':\n description: Collection creation result\n\n /core/dataset/data/pushData:\n post:\n summary: Push Data to Collection\n description: Manually insert Q&A or text data into a collection.\n tags:\n - Dataset Data\n requestBody:\n content:\n application/json:\n schema:\n type: object\n required:\n - collectionId\n - data\n properties:\n collectionId:\n type: string\n trainingType:\n type: string\n enum: [chunk, qa]\n data:\n type: array\n items:\n type: object\n required:\n - q\n properties:\n q:\n type: string\n description: Main content / Question\n a:\n type: string\n description: Auxiliary content / Answer\n indexes:\n type: array\n items:\n type: object\n properties:\n text:\n type: string\n responses:\n '200':\n description: Insertion result\n\n /core/dataset/searchTest:\n post:\n summary: Search Test\n tags:\n - Dataset Data\n requestBody:\n content:\n application/json:\n schema:\n type: object\n required:\n - datasetId\n - text\n properties:\n datasetId:\n type: string\n text:\n type: string\n limit:\n type: integer\n default: 3000\n similarity:\n type: number\n default: 0\n searchMode:\n type: string\n enum: [embedding, fullTextReRank]\n responses:\n '200':\n description: Search results\n\n # ============================\n # Share Link Identity\n # ============================\n /shareAuth/init:\n post:\n summary: Share Link Auth Init (User Defined)\n description: This is an interface YOU implement on your server, not a FastGPT API. FastGPT calls this hook.\n tags:\n - Share Auth Hooks\n requestBody:\n content:\n application/json:\n schema:\n type: object\n properties:\n token:\n type: string\n responses:\n '200':\n description: Returns success and uid\n\n /shareAuth/start:\n post:\n summary: Share Link Auth Start (User Defined)\n description: Hook called before chat starts.\n tags:\n - Share Auth Hooks\n requestBody:\n content:\n application/json:\n schema:\n type: object\n properties:\n token:\n type: string\n question:\n type: string\n responses:\n '200':\n description: Returns success status\n\n /shareAuth/finish:\n post:\n summary: Share Link Auth Finish (User Defined)\n description: Hook called after chat finishes (for billing/logging).\n tags:\n - Share Auth Hooks\n requestBody:\n content:\n application/json:\n schema:\n type: object\n properties:\n token:\n type: string\n responseData:\n type: array\n items:\n type: object\n responses:\n '200':\n description: Acknowledge receipt", "variables": [], "notes": "FastGPT API doc", "metadata": { "source": { "provider": "github-prompts", "repository": "https://github.com/hduhelp/AcademicSupportSystem", "path": ".github/prompts/fastgpt.prompt.md", "ref": "6bfc67cf02b001e67e1207a073460fead57661db", "url": "https://github.com/hduhelp/AcademicSupportSystem/blob/6bfc67cf02b001e67e1207a073460fead57661db/.github/prompts/fastgpt.prompt.md", "key": "hduhelp/AcademicSupportSystem/.github/prompts/fastgpt.prompt.md" } } }

fastgpt-api

About

============================

Chat Interface

============================

============================

Chat History Management

============================

============================

Dataset (Knowledge Base)

============================

============================

Dataset Collection (Files/Data)

============================

============================

Share Link Identity

============================

Use it

Manifest

Reviews