FastGPT Cloud API Documentation Overview
FastGPT provides two distinct categories of cloud API documentation, split by use case and geographic region. All documentation is hosted on regional domains to ensure that endpoint references and usage guidelines align with a user’s specific deployment environment. The two core API categories are Developer (Dev) API and System OpenAPI, each with dedicated regional reference materials tailored to their respective use cases.
Dev API Documentation
Dev API documentation supports developers building custom integrations with FastGPT’s end-user application workflows, such as chatbot interactions and custom tool connections. Two regional documentation sets are available for developers:
- China Mainland documentation: https://cloud.fastgpt.cn/apidoc/devapi
- International documentation: https://cloud.fastgpt.io/apidoc/devapi
Each Dev API page provides structured details about available endpoints, required request parameters, and standard response formats for the selected regional deployment.
System OpenAPI Documentation
System OpenAPI documentation covers administrative platform operations, including workspace management and global configuration tasks. These resources are intended for platform administrators overseeing FastGPT deployments. Regional documentation links for this category are:
- China Mainland documentation: https://cloud.fastgpt.cn/apidoc/systemopenapi
- International documentation: https://cloud.fastgpt.io/apidoc/systemopenapi
Step-by-Step Documentation Access Workflow
- Confirm your FastGPT deployment region: verify whether your instance uses the China Mainland or international cloud hosting environment.
- Select the appropriate API category: choose Dev API for custom end-user application integrations, or System OpenAPI for platform administration and configuration work.
- Navigate to the matching regional documentation URL using the provided links for your chosen category and region.
Source: FastGPT official source
Applicability and version scope
Use this page for the documented API scenario. Confirm the FastGPT, dependency, API, and deployment versions in the official source before applying a change.
Safety guardrails
Use [REDACTED_CREDENTIAL] for credentials and private data. Confirm the documented environment and version before review.
Rollback guidance
Restore the prior technical-content authority snapshot. Restore saved configuration and data snapshots, then repeat the smallest verification scenario.