Developers
Choose API integration or extension development to connect FastGPT and build plugins, model presets, and Skills.
Choose a development task
API integration
Make your first request, then integrate Apps, conversations, and Datasets.
Plugin system
Build system tool plugins, contribute model presets, and package them for FastGPT.
Developer Integration Architecture
FastGPT provides an open capability matrix for enterprise systems and developers:
Keep API keys on a trusted server. Identity proxy is optional and requires endpoint support and a trusted mapping to a member in the same team. MCP clients use the separately configured MCP service and its authentication.
Credential Types and Authentication
Each endpoint declares the credentials it accepts. Check the authentication method for each endpoint in /apidoc/systemopenapi or /apidoc/devapi before integrating.
| Credential | Transport Location | Permission Scope | Recommended Scenario |
|---|---|---|---|
| Personal API key | Authorization: Bearer <apiKey> | Accesses permitted team resources as the issuing member on endpoints that accept personal API keys | Backend integrations, automated jobs, model calls |
| App API key (v4.18.0+) | Authorization: Bearer <apiKey> | Bound to one app for its chat and chat management endpoints; authorization comes from the key itself | Integrating a specific app and identifying business users with customUid |
| User Session Token | Cookie fastgpt_token or token header | Current member permissions, subject to endpoint authorization and session checks | Web UI communication, same-origin management APIs |
| Root Key | Header rootkey: <ROOT_KEY> | Administrative operations on endpoints that explicitly enable root authentication | Cross-team maintenance, model status probing, migrations |
Core Integration Workflows
- API Quick Start: Choose a personal API key or an app API key, execute the first end-to-end request, and connect via the official OpenAI SDK.
- Identity Proxy: Execute on behalf of end users using
authProxyto enforce member-level permissions and audit logging. - Knowledge Base Integration: Create collections via API, push content to training queues asynchronously, and run search tests.
Plugin System
- Plugin development: Explore plugin types and development paths, start with your first tool, and continue to debugging and publishing.
- System Tool Development: Build single tools (
defineTool) and tool suites (defineToolSet) with@fastgpt-plugin/cli. - Model Presets: Register new model providers and map AIProxy channels.
- Package and SDK Reference: Inspect plugin directory conventions, package archive formats, and SDK type definitions.
- Skill Development Tutorial: Author custom Skills in the sandbox and bind them to an Agent.
Machine-Readable OpenAPI Contracts
Each FastGPT deployment generates OpenAPI 3.1 specification files locally:
- System OpenAPI (API Key Operations): Access
/apidoc/systemopenapi(UI) or/api/apidoc/systemopenapi.json(JSON). - Dev API (Full Developer Operations): Access
/apidoc/devapi(UI) or/api/apidoc/devapi.json(JSON).
When maintaining older integrations, refer to Historical API Parameters and Migration.
Last updated