FastGPT OpenAPI (1.0.0)

Download OpenAPI specification:Download

/common/file/previewContent

Responses

Response samples

200

Content type

application/json

{ }

/common/file/read

Responses

Response samples

200

Content type

application/json

{ }

/common/file/upload

Responses

Response samples

200

Content type

application/json

{ }

/common/file/uploadImage

Responses

Response samples

200

Content type

application/json

{ }

/common/system/getInitData

Responses

Response samples

200

Content type

application/json

{ }

/common/system/unlockTask

Responses

Response samples

200

Content type

application/json

{ }

/common/tools/urlFetch

Responses

Response samples

200

Content type

application/json

{ }

/core/ai/agent/createQuestionGuide

Responses

Response samples

200

Content type

application/json

{ }

/core/ai/token

Responses

Response samples

200

Content type

application/json

{ }

/core/app/copy

Responses

Response samples

200

Content type

application/json

{"string": null
}

/core/app/create

Responses

Response samples

200

Content type

application/json

{ }

/core/app/del

Responses

Response samples

200

Content type

application/json

{ }

获取我的模型

Responses

Response samples

200

Content type

application/json

{ }

/core/app/folder/create

Responses

Response samples

200

Content type

application/json

{ }

/core/app/folder/path

Responses

Response samples

200

Content type

application/json

{ }

/core/app/getChatLogs

Responses

Response samples

200

Content type

application/json

{ }

/core/app/httpPlugin/create

Responses

Response samples

200

Content type

application/json

{ }

/core/app/httpPlugin/getApiSchemaByUrl

Responses

Response samples

200

Content type

application/json

{ }

/core/app/httpPlugin/update

Responses

Response samples

200

Content type

application/json

{ }

/core/app/list

Responses

Response samples

200

Content type

application/json

{ }

/core/app/plugin/getPreviewNode

query Parameters

appId

required

string

Responses

Response samples

200

Content type

application/json

{ }

/core/app/plugin/getSystemPluginTemplates

Responses

Response samples

200

Content type

application/json

{ }

/core/app/plugin/path

query Parameters

parentId

required

ParentIdType

Responses

Response samples

200

Content type

application/json

null

resume the app's inherit permission.

query Parameters

appId

required

string

Responses

Response samples

200

Content type

application/json

{ }

/core/app/template/detail

Responses

Response samples

200

Content type

application/json

{ }

/core/app/template/list

Responses

Response samples

200

Content type

application/json

{ }

/core/app/transitionWorkflow

Responses

Response samples

200

Content type

application/json

{"string": null
}

修改默认权限 1. 继承态目录：关闭继承态，修改权限，同步子目录默认权限 2. 继承态资源：

修改默认权限

继承态目录：关闭继承态，修改权限，同步子目录默认权限
继承态资源：关闭继承态，修改权限, 复制父级协作者。
非继承目录：修改权限，同步子目录默认权限
非继承资源：修改权限

移动

继承态目录：改 parentId, 修改成父的默认权限，同步子目录默认权限和协作者
继承态资源：改 parentId
非继承：改 parentId

Responses

Response samples

200

Content type

application/json

{ }

/core/app/version/detail

Responses

Response samples

200

Content type

application/json

{ }

/core/app/version/latest

query Parameters

appId

required

string

Responses

Response samples

200

Content type

application/json

{"StoreNodeItemType[]": null,
"StoreEdgeItemType[]": null,
"AppChatConfigType": null
}

/core/app/version/list

Responses

Response samples

200

Content type

application/json

{ }

/core/app/version/listWorkflowx

Responses

Response samples

200

Content type

application/json

{"string": null,
"Date": null,
"boolean | TSUndefinedKeyword": null
}

/core/app/version/publish

Responses

Response samples

200

Content type

application/json

{ }

/core/app/version/revert

Responses

Response samples

200

Content type

application/json

{ }

/core/app/version/update

Responses

Response samples

200

Content type

application/json

{ }

/core/chat/chatTest

Responses

Response samples

200

Content type

application/json

{ }

clear chat history

Responses

Response samples

200

Content type

application/json

{ }

clear chat history

Responses

Response samples

200

Content type

application/json

{ }

/core/chat/feedback/closeCustom

Responses

Response samples

200

Content type

application/json

{ }

/core/chat/feedback/updateUserFeedback

Responses

Response samples

200

Content type

application/json

{ }

/core/chat/getHistories

Responses

Response samples

200

Content type

application/json

{ }

/core/chat/getResData

query Parameters

OutLinkChatAuthProps & TSTypeLiteral

Responses

Response samples

200

Content type

application/json

null

/core/chat/init

Responses

Response samples

200

Content type

application/json

{ }

/core/chat/inputGuide/countTotal

query Parameters

appId

required

string

Responses

Response samples

200

Content type

application/json

{"number": null
}

/core/chat/inputGuide/create

Responses

Response samples

200

Content type

application/json

{"number": null
}

/core/chat/inputGuide/delete

Responses

Response samples

200

Content type

application/json

{ }

/core/chat/inputGuide/deleteAll

Responses

Response samples

200

Content type

application/json

{ }

/core/chat/inputGuide/list

Responses

Response samples

200

Content type

application/json

null

/core/chat/inputGuide/query

Responses

Response samples

200

Content type

application/json

null

/core/chat/inputGuide/update

Responses

Response samples

200

Content type

application/json

{ }

/core/chat/item/delete

Responses

Response samples

200

Content type

application/json

{ }

/core/chat/item/getSpeech

Responses

Response samples

200

Content type

application/json

{ }

/core/chat/outLink/init

Responses

Response samples

200

Content type

application/json

{ }

/core/chat/team/init

Responses

Response samples

200

Content type

application/json

{ }

update chat top, custom title

Responses

Response samples

200

Content type

application/json

{ }

get all dataset by teamId or tmbId

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/collection/create/csvTable

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/collection/create/fileId

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/collection/create/link

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/collection/create/localFile

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/collection/create/text

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/collection/create

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/collection/delete

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/collection/detail

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/collection/list

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/collection/paths

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/collection/read

query Parameters

collectionId

required

string

Responses

Response samples

200

Content type

application/json

{"url": null,
"string": null
}

/core/dataset/collection/scrollList

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/collection/sync/link

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/collection/update

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/create

Responses

Response samples

200

Content type

application/json

"string"

/core/dataset/data/delete

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/data/detail

Responses

Response samples

200

Content type

application/json

{"string": null
}

/core/dataset/data/insertData

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/data/list

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/data/pushData

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/data/update

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/delete

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/detail

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/exportAll

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/file/getPreviewChunks

Responses

Response samples

200

Content type

application/json

null

/core/dataset/folder/create

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/list

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/paths

Responses

Response samples

200

Content type

application/json

{ }

resume the dataset's inherit permission.

query Parameters

datasetId

required

string

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/searchTest

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/training/getDatasetTrainingQueue

Responses

Response samples

200

Content type

application/json

{"number": null
}

/core/dataset/training/getQueueLen

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/training/rebuildEmbedding

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/update

Responses

Response samples

200

Content type

application/json

null

/core/workflow/debug

Responses

Response samples

200

Content type

application/json

{ }

/lafApi/[...path]

Responses

Response samples

200

Content type

application/json

{ }

/plugins/TFSwitch/index

Responses

Response samples

200

Content type

application/json

{ }

/plugins/customFeedback/index

Responses

Response samples

200

Content type

application/json

{ }

/plugins/customFeedback/v2/index

Responses

Response samples

200

Content type

application/json

{ }

/plugins/textEditor/index

Responses

Response samples

200

Content type

application/json

{ }

/plugins/textEditor/v2/index

Responses

Response samples

200

Content type

application/json

{ }

/support/openapi/create

Responses

Response samples

200

Content type

application/json

{ }

/support/openapi/delete

query Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{ }

/support/openapi/list

Responses

Response samples

200

Content type

application/json

{ }

/support/openapi/update

Responses

Response samples

200

Content type

application/json

{ }

/support/outLink/create

Responses

Response samples

200

Content type

application/json

"string"

delete a shareChat by shareChatId

query Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{ }

/support/outLink/feishu/[token]

query Parameters

TSAnyKeyword

Responses

Response samples

200

Content type

application/json

{ }

查询应用内全部 Outlink

query Parameters

appId required	string 应用 ID
type required	string 应用 ID 类型

Responses

Response samples

200

Content type

application/json

null

/support/outLink/offiaccount/[token]

query Parameters

TSAnyKeyword

Responses

Response samples

200

Content type

application/json

{ }

/support/outLink/update

Responses

Response samples

200

Content type

application/json

{ }

/support/outLink/wecom/[token]

query Parameters

TSAnyKeyword

Responses

Response samples

200

Content type

application/json

{ }

/support/user/account/loginByPassword

Responses

Response samples

200

Content type

application/json

{ }

/support/user/account/loginout

Responses

Response samples

200

Content type

application/json

{ }

/support/user/account/tokenLogin

Responses

Response samples

200

Content type

application/json

{ }

/support/user/account/update

Responses

Response samples

200

Content type

application/json

{ }

/support/user/account/updatePasswordByOld

Responses

Response samples

200

Content type

application/json

{ }

/support/user/team/limit/datasetSizeLimit

Responses

Response samples

200

Content type

application/json

{ }

/support/user/team/limit/exportDatasetLimit

Responses

Response samples

200

Content type

application/json

{ }

/support/user/team/limit/webSyncLimit

Responses

Response samples

200

Content type

application/json

{ }

/support/user/team/plan/getTeamPlanStatus

Responses

Response samples

200

Content type

application/json

{ }

/support/user/team/update

Responses

Response samples

200

Content type

application/json

{ }

/support/wallet/usage/createTrainingUsage

Responses

Response samples

200

Content type

application/json

{ }

/system/img/[id]

Responses

Response samples

200

Content type

application/json

{ }

/v1/audio/transcriptions

Responses

Response samples

200

Content type

application/json

{ }

/v1/chat/completions

Responses

Response samples

200

Content type

application/json

{ }

/v1/embeddings

Responses

Response samples

200

Content type

application/json

{ }