Developers
Choose API integration or extension development to connect FastGPT and build plugins, model presets, and Skills.
Choose a development task
API integration
Plugin system
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 |
|---|---|---|---|
| Team API Key | Authorization: Bearer <apiKey> | Scoped to resources available to the issuing team member | Backend integrations, automated jobs, model calls |
| 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: Obtain team API keys, 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. - Application and Workflow Integration: Execute published Chat Agents, Agent V2, and Workflows while injecting global variables.
- Conversations and 18 SSE Stream Events: Maintain persistent
chatIdsessions and parse answer chunks, thoughts, node statuses, plans, and interactive pauses. - 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