FastGPT OpenAPI (1.0.0)

Download OpenAPI specification:Download

/common/file/previewContent

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{ }

/common/file/read

Responses

Response samples

200

Content type

application/json

{ }

/common/file/upload

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{ }

/common/file/uploadImage

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/common/system/getInitData

Responses

Response samples

200

Content type

application/json

{ }

/common/system/unlockTask

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/common/tools/urlFetch

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/core/ai/agent/createQuestionGuide

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/core/ai/token

Responses

Response samples

200

Content type

application/json

{ }

/core/app/copy

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{"string": null
}

/core/app/create

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/core/app/del

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

获取我的模型

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/core/app/folder/create

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/core/app/folder/path

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/core/app/getChatLogs

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/core/app/httpPlugin/create

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/core/app/httpPlugin/getApiSchemaByUrl

Responses

Response samples

200

Content type

application/json

{ }

/core/app/httpPlugin/update

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/core/app/list

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/core/app/plugin/getPreviewNode

Authorizations:

token

query Parameters

appId

required

string

Responses

Response samples

200

Content type

application/json

{ }

/core/app/plugin/getSystemPluginTemplates

Authorizations:

token

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.

Authorizations:

token

query Parameters

appId

required

string

Responses

Response samples

200

Content type

application/json

{ }

/core/app/template/detail

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/core/app/template/list

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/core/app/transitionWorkflow

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{"string": null
}

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

修改默认权限

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

移动

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

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/core/app/version/detail

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/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

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/core/app/version/revert

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/core/app/version/update

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/core/chat/chatTest

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

clear chat history

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

clear chat history

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/core/chat/feedback/closeCustom

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/core/chat/feedback/updateUserFeedback

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{ }

/core/chat/getHistories

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/core/chat/getResData

Authorizations:

token

query Parameters

OutLinkChatAuthProps & TSTypeLiteral

Responses

Response samples

200

Content type

application/json

null

/core/chat/init

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/core/chat/inputGuide/countTotal

Authorizations:

token

query Parameters

appId

required

string

Responses

Response samples

200

Content type

application/json

{"number": null
}

/core/chat/inputGuide/create

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{"number": null
}

/core/chat/inputGuide/delete

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/core/chat/inputGuide/deleteAll

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/core/chat/inputGuide/list

Authorizations:

token

Responses

Response samples

200

Content type

application/json

null

/core/chat/inputGuide/query

Authorizations:

token

Responses

Response samples

200

Content type

application/json

null

/core/chat/inputGuide/update

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/core/chat/item/delete

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/core/chat/item/getSpeech

Authorizations:

token

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

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

get all dataset by teamId or tmbId

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/collection/create/csvTable

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/collection/create/fileId

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/collection/create/link

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/collection/create/localFile

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/collection/create/text

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/collection/create

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/collection/delete

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/collection/detail

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/collection/list

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/collection/paths

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/collection/read

Authorizations:

apiKey

query Parameters

collectionId

required

string

Responses

Response samples

200

Content type

application/json

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

/core/dataset/collection/scrollList

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/collection/sync/link

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/collection/update

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/create

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

"string"

/core/dataset/data/delete

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/data/detail

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{"string": null
}

/core/dataset/data/insertData

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/data/list

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/data/pushData

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/data/update

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/delete

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/detail

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/exportAll

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/file/getPreviewChunks

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

null

/core/dataset/folder/create

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/list

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/paths

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

resume the dataset's inherit permission.

Authorizations:

token

query Parameters

datasetId

required

string

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/searchTest

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/training/getDatasetTrainingQueue

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{"number": null
}

/core/dataset/training/getQueueLen

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/training/rebuildEmbedding

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{ }

/core/dataset/update

Authorizations:

token

Responses

Response samples

200

Content type

application/json

null

/core/workflow/debug

Authorizations:

token

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

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/support/openapi/delete

Authorizations:

token

query Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{ }

/support/openapi/list

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/support/openapi/update

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/support/outLink/create

Authorizations:

token

Responses

Response samples

200

Content type

application/json

"string"

delete a shareChat by shareChatId

Authorizations:

token

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

Authorizations:

token

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

Authorizations:

token

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

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/support/user/account/update

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/support/user/account/updatePasswordByOld

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/support/user/team/limit/datasetSizeLimit

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/support/user/team/limit/exportDatasetLimit

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/support/user/team/limit/webSyncLimit

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/support/user/team/plan/getTeamPlanStatus

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/support/user/team/update

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/support/wallet/usage/createTrainingUsage

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{ }

/system/img/[id]

Responses

Response samples

200

Content type

application/json

{ }

/v1/audio/transcriptions

Authorizations:

token

Responses

Response samples

200

Content type

application/json

{ }

/v1/chat/completions

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{ }

/v1/embeddings

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{ }