### Create Question Guide - POST Request

Source: https://cloud.fastgpt.cn/openapi

Use this endpoint to generate a list of recommended guide questions based on conversation history. Requires message history and authentication tokens.

```Shell
curl https://cloud.fastgpt.cn/api/core/ai/agent/createQuestionGuide \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{ \
  "shareId": "", \
  "outLinkUid": "", \
  "teamId": "", \
  "teamToken": "", \
  "messages": [ \
    { \
      "role": "user", \
      "content": "你好", \
      "name": "", \
      "tool_calls": [ \
        {} \
      ], \
      "tool_call_id": "" \
    } \
  ] \
}'
```

--------------------------------

### Create Question Guide Response Schema

Source: https://cloud.fastgpt.cn/openapi

Schema for the successful response when creating a question guide, returning a list of recommended questions.

```JSON
[
  "你能帮我做什么？",
  "如何使用这个功能？"
]
```

--------------------------------

### Chat Input Guide API

Source: https://cloud.fastgpt.cn/openapi

Endpoints for managing chat input guides.

```APIDOC
## POST /core/chat/inputGuide/list

### Description
Lists chat input guides.

### Method
POST

### Endpoint
/core/chat/inputGuide/list

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## GET /core/chat/inputGuide/countTotal

### Description
Gets the total count of chat input guides.

### Method
GET

### Endpoint
/core/chat/inputGuide/countTotal

### Parameters
#### Query Parameters
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## POST /core/chat/inputGuide/create

### Description
Creates a new chat input guide.

### Method
POST

### Endpoint
/core/chat/inputGuide/create

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## DELETE /core/chat/inputGuide/delete

### Description
Deletes a chat input guide.

### Method
DELETE

### Endpoint
/core/chat/inputGuide/delete

### Parameters
#### Query Parameters
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## DELETE /core/chat/inputGuide/deleteAll

### Description
Deletes all chat input guides.

### Method
DELETE

### Endpoint
/core/chat/inputGuide/deleteAll

### Parameters
#### Query Parameters
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## POST /core/chat/inputGuide/query

### Description
Queries chat input guides.

### Method
POST

### Endpoint
/core/chat/inputGuide/query

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## PUT /core/chat/inputGuide/update

### Description
Updates a chat input guide.

### Method
PUT

### Endpoint
/core/chat/inputGuide/update

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

--------------------------------

### POST /api/core/ai/agent/createQuestionGuide

Source: https://cloud.fastgpt.cn/openapi

Generates a list of recommended guiding questions based on conversation history.

```APIDOC
## POST /api/core/ai/agent/createQuestionGuide

### Description
Generates a list of recommended guiding questions based on conversation history.

### Method
POST

### Endpoint
/api/core/ai/agent/createQuestionGuide

### Parameters
#### Request Body
- **messages** (array of object) - Required - Conversation history message list.
- **outLinkUid** (string) - Optional - External link user ID.
- **shareId** (string) - Optional - Share link ID.
- **teamId** (string) - Optional - Team ID.
- **teamToken** (string) - Optional - Team Token.

### Request Example
```json
{
  "shareId": "",
  "outLinkUid": "",
  "teamId": "",
  "teamToken": "",
  "messages": [
    {
      "role": "user",
      "content": "你好",
      "name": "",
      "tool_calls": [
        {}
      ],
      "tool_call_id": ""
    }
  ]
}
```

### Response
#### Success Response (200)
- **Array of strings** - A list of recommended guiding questions.

#### Response Example
```json
[
  "你能帮我做什么？",
  "如何使用这个功能？"
]
```
```

--------------------------------

### Get Application Log Keys

Source: https://cloud.fastgpt.cn/openapi

Send a GET request to retrieve application log keys. Requires an 'appId' as a query parameter.

```Shell
Send Send get request to https://cloud.fastgpt.cn/api/core/app/logs/getLogKeys

```

--------------------------------

### GET /api/core/app/logs/getLogKeys

Source: https://cloud.fastgpt.cn/openapi

Retrieves log keys for an application. Requires an appId as a query parameter.

```APIDOC
## GET /api/core/app/logs/getLogKeys

### Description
Retrieves log keys for an application. Requires an appId as a query parameter.

### Method
GET

### Endpoint
/api/core/app/logs/getLogKeys

### Query Parameters
- **appId** (string) - Required - The ID of the application.

### Response
#### Success Response (200)
- (string) - A string containing log keys.

### Request Example
```shell
curl -X GET "https://cloud.fastgpt.cn/api/core/app/logs/getLogKeys?appId=68ad85a7463006c963799a05"
```
```

--------------------------------

### GET /api/core/chat/resume

Source: https://cloud.fastgpt.cn/openapi

Resumes a streaming response for a chat. If the conversation is ongoing, it requires SSE; otherwise, it returns a JSON response.

```APIDOC
## GET /api/core/chat/resume

### Description
Resumes a streaming response for a chat. If the conversation is ongoing, it requires SSE; otherwise, it returns a JSON response. This endpoint is designed to work with `/v2/chat/completions`.

### Method
GET

### Endpoint
/api/core/chat/resume

### Parameters
#### Query Parameters
- **appId** (string) - Required - Application ID (ObjectId format).
- **chatId** (string) - Required - Chat ID.
- **shareId** (string) - Optional - Share ID.
- **outLinkUid** (string) - Optional - External link user ID.
- **teamId** (string) - Optional - Team ID (ObjectId format).
- **teamToken** (string) - Optional - Team Token.

### Request Example
```
curl 'https://cloud.fastgpt.cn/api/core/chat/resume?shareId=&outLinkUid=&teamId=68ee0bd23d17260b7829b137&teamToken=&appId=68ee0bd23d17260b7829b137&chatId=bEdzC6PNupZrr1RoVutMF2DL'
```

### Response
#### Success Response (200)
- **chatGenerateStatus** (number) - Status of chat generation.
- **hasBeenRead** (boolean) - Indicates if the message has been read.
- **records** (object) - Contains chat records.
  - **list** (array) - List of chat records.
  - **total** (number) - Total number of records.
  - **hasMorePrev** (boolean) - Indicates if there are more previous records.
  - **hasMoreNext** (boolean) - Indicates if there are more next records.

#### Error Response (406)
- **Description**: Conversation is still generating, but the request did not specify acceptance of SSE.

#### Response Example (200)
```json
{
  "chatGenerateStatus": 1,
  "hasBeenRead": true,
  "records": {
    "list": [],
    "total": 2,
    "hasMorePrev": false,
    "hasMoreNext": false
  }
}
```
```

--------------------------------

### Team Plugin Management API

Source: https://cloud.fastgpt.cn/openapi

APIs for managing team plugins, including listing, toggling installation, and retrieving tool details.

```APIDOC
## GET /core/plugin/team/list

### Description
Retrieves a list of team plugins.

### Method
GET

### Endpoint
/core/plugin/team/list

## POST /core/plugin/team/toggleInstall

### Description
Toggles the installation status of a team plugin.

### Method
POST

### Endpoint
/core/plugin/team/toggleInstall

## GET /core/plugin/team/toolDetail

### Description
Retrieves detailed information about a team plugin tool.

### Method
GET

### Endpoint
/core/plugin/team/toolDetail
```

--------------------------------

### Get LLM Request Trace - GET Request

Source: https://cloud.fastgpt.cn/openapi

Retrieve detailed information about an LLM request, including its request body and response content, using the provided requestId.

```Shell
curl 'https://cloud.fastgpt.cn/api/core/ai/record/getRecord?requestId=V1StGXR8_Z5jdHi6B-myT'
```

--------------------------------

### GET /api/core/chat/helperBot/getRecords

Source: https://cloud.fastgpt.cn/openapi

Retrieves chat records with pagination. You can specify pageSize, offset, or pageNum for pagination. Requires type and chatId.

```APIDOC
## GET /api/core/chat/helperBot/getRecords

### Description
Retrieves chat records with pagination. You can specify pageSize, offset, or pageNum for pagination. Requires type and chatId.

### Method
GET

### Endpoint
/api/core/chat/helperBot/getRecords

### Query Parameters
- **pageSize** (number) - Optional - Number of records per page.
- **offset** (number) - Optional - Offset for pagination (use either offset or pageNum).
- **pageNum** (number) - Optional - Page number (use either offset or pageNum).
- **type** (string) - Required - Enum: topAgent.
- **chatId** (string) - Required - The ID of the chat.

### Response
#### Success Response (200)
- **total** (number) - The total number of records.
- **list** (array) - A list of chat records.

### Request Example
```shell
curl 'https://cloud.fastgpt.cn/api/core/chat/helperBot/getRecords?pageSize=1&offset=1&pageNum=1&type=topAgent&chatId='
```

### Response Example
```json
{
  "total": 0,
  "list": []
}
```
```

--------------------------------

### GET /api/core/ai/record/getRecord

Source: https://cloud.fastgpt.cn/openapi

Retrieves detailed information about an LLM request, including request and response content, using a request ID.

```APIDOC
## GET /api/core/ai/record/getRecord

### Description
Retrieves detailed information about an LLM request, including request and response content, using a request ID.

### Method
GET

### Endpoint
/api/core/ai/record/getRecord

### Parameters
#### Query Parameters
- **requestId** (string) - Required - LLM request trace ID.

### Request Example
```
curl 'https://cloud.fastgpt.cn/api/core/ai/record/getRecord?requestId=V1StGXR8_Z5jdHi6B-myT'
```

### Response
#### Success Response (200)
- **_id** (string) - Unique identifier for the record.
- **requestId** (string) - The LLM request trace ID.
- **body** (object) - The request body.
- **response** (object) - The response content.
- **createdAt** (string) - Timestamp of record creation.

#### Response Example
```json
{
  "_id": "68ee0bd23d17260b7829b137",
  "requestId": "V1StGXR8_Z5jdHi6B-myT",
  "body": {
    "propertyName*": "anything"
  },
  "response": {
    "propertyName*": "anything"
  },
  "createdAt": "2024-01-01T00:00:00.000Z"
}
```
```

--------------------------------

### Resume Streaming Response - GET Request

Source: https://cloud.fastgpt.cn/openapi

Resume a streaming chat response. For ongoing conversations, this requires an SSE request. Completed conversations return JSON. Requires app ID and chat ID.

```Shell
curl 'https://cloud.fastgpt.cn/api/core/chat/resume?shareId=&outLinkUid=&teamId=68ee0bd23d17260b7829b137&teamToken=&appId=68ee0bd23d17260b7829b137&chatId=bEdzC6PNupZrr1RoVutMF2DL'
```

--------------------------------

### Initiate Chat Completion with Files

Source: https://cloud.fastgpt.cn/openapi

This endpoint processes chat queries, potentially including file uploads. It requires 'chatId', 'chatItemId', 'query', and a 'files' array. The 'metadata' object contains detailed configuration for the chat session.

```Shell
curl https://cloud.fastgpt.cn/api/core/chat/helperBot/completions \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{ \
  "chatId": "", \
  "chatItemId": "", \
  "query": "", \
  "files": [ \
    { \
      "type": "image", \
      "key": "", \
      "url": "", \
      "name": "" \
    } \
  ], \
  "metadata": { \
    "type": "topAgent", \
    "data": { \
      "role": "", \
      "taskObject": "", \
      "systemPrompt": "", \
      "selectedTools": [ \
        "" \
      ], \
      "selectedDatasets": [ \
        "" \
      ], \
      "fileUpload": true, \
      "enableSandbox": true \
    } \
  }'

```

--------------------------------

### Application Management API

Source: https://cloud.fastgpt.cn/openapi

Endpoints for managing applications within FastGPT.

```APIDOC
## POST /core/app/create

### Description
Creates a new application.

### Method
POST

### Endpoint
/core/app/create

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

--------------------------------

### Collection Creation API

Source: https://cloud.fastgpt.cn/openapi

APIs for creating new collections, supporting various data sources like files, links, text, and API integrations.

```APIDOC
## POST /core/dataset/collection/create

### Description
Creates a new collection.

### Method
POST

### Endpoint
/core/dataset/collection/create

## POST /core/dataset/collection/create/reTrainingCollection

### Description
Creates a new collection and retrains it.

### Method
POST

### Endpoint
/core/dataset/collection/create/reTrainingCollection

## POST /core/dataset/collection/create/fileId

### Description
Creates a collection from a file ID.

### Method
POST

### Endpoint
/core/dataset/collection/create/fileId

## POST /core/dataset/collection/create/localFile

### Description
Creates a collection from a local file.

### Method
POST

### Endpoint
/core/dataset/collection/create/localFile

## POST /core/dataset/collection/create/link

### Description
Creates a collection from a web link.

### Method
POST

### Endpoint
/core/dataset/collection/create/link

## POST /core/dataset/collection/create/text

### Description
Creates a collection from provided text.

### Method
POST

### Endpoint
/core/dataset/collection/create/text

## POST /core/dataset/collection/create/apiCollection

### Description
Creates a collection from an API source (version 1).

### Method
POST

### Endpoint
/core/dataset/collection/create/apiCollection

## POST /core/dataset/collection/create/apiCollectionV2

### Description
Creates a collection from an API source (version 2).

### Method
POST

### Endpoint
/core/dataset/collection/create/apiCollectionV2

## POST /core/dataset/collection/create/images

### Description
Creates a collection from images.

### Method
POST

### Endpoint
/core/dataset/collection/create/images

## POST /core/dataset/collection/create/backup

### Description
Creates a backup collection.

### Method
POST

### Endpoint
/core/dataset/collection/create/backup

## POST /core/dataset/collection/create/template

### Description
Creates a collection from a template.

### Method
POST

### Endpoint
/core/dataset/collection/create/template
```

--------------------------------

### Paginate and Retrieve Records

Source: https://cloud.fastgpt.cn/openapi

Use this endpoint to retrieve chat records with pagination. You can specify page size, offset, or page number. Ensure 'type' is set to 'topAgent' and provide a 'chatId'.

```Shell
curl 'https://cloud.fastgpt.cn/api/core/chat/helperBot/getRecords?pageSize=1&offset=1&pageNum=1&type=topAgent&chatId='

```

--------------------------------

### POST /api/core/chat/helperBot/completions

Source: https://cloud.fastgpt.cn/openapi

Processes chat interactions, potentially with file uploads. Requires chatId, chatItemId, query, files, and metadata in the request body.

```APIDOC
## POST /api/core/chat/helperBot/completions

### Description
Processes chat interactions, potentially with file uploads. Requires chatId, chatItemId, query, files, and metadata in the request body.

### Method
POST

### Endpoint
/api/core/chat/helperBot/completions

### Request Body
- **chatId** (string) - Required - The ID of the chat.
- **chatItemId** (string) - Required - The ID of the chat item.
- **query** (string) - Required - The user's query.
- **files** (array object[]) - Required - An array of file objects.
  - **type** (string) - Required - Type of the file.
  - **metadata** (object) - Required - Metadata for the file.
    - **query** (string) - Required - Query related to the file.
- **metadata** (object) - Required - Additional metadata for the request.
  - **type** (string) - Required - Type of metadata (e.g., topAgent).
  - **data** (object) - Required - Data associated with the metadata.
    - **role** (string) - Optional - Role for the chat.
    - **taskObject** (string) - Optional - Task object.
    - **systemPrompt** (string) - Optional - System prompt for the chat.
    - **selectedTools** (array) - Optional - List of selected tools.
    - **selectedDatasets** (array) - Optional - List of selected datasets.
    - **fileUpload** (boolean) - Optional - Whether file upload is enabled.
    - **enableSandbox** (boolean) - Optional - Whether sandbox is enabled.

### Request Example
```shell
curl https://cloud.fastgpt.cn/api/core/chat/helperBot/completions \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{ \
  "chatId": "", \
  "chatItemId": "", \
  "query": "", \
  "files": [ \
    { \
      "type": "image", \
      "key": "", \
      "url": "", \
      "name": "" \
    } \
  ], \
  "metadata": { \
    "type": "topAgent", \
    "data": { \
      "role": "", \
      "taskObject": "", \
      "systemPrompt": "", \
      "selectedTools": [ \
        "" \
      ], \
      "selectedDatasets": [ \
        "" \
      ], \
      "fileUpload": true, \
      "enableSandbox": true \
    } \
  }'
```

### Response
#### Success Response (200)
- (stream+json) - A stream of JSON objects representing the processing result.

### Response Example
```json
null
```
```

--------------------------------

### Knowledge Base Management API

Source: https://cloud.fastgpt.cn/openapi

APIs for managing knowledge bases, including creation, listing, retrieval, updating, and testing.

```APIDOC
## POST /core/dataset/create

### Description
Creates a new knowledge base.

### Method
POST

### Endpoint
/core/dataset/create

## POST /core/dataset/createWithFiles

### Description
Creates a new knowledge base with associated files.

### Method
POST

### Endpoint
/core/dataset/createWithFiles

## POST /core/dataset/folder/create

### Description
Creates a new folder for knowledge bases.

### Method
POST

### Endpoint
/core/dataset/folder/create

## POST /core/dataset/list

### Description
Retrieves a list of knowledge bases.

### Method
POST

### Endpoint
/core/dataset/list

## GET /core/dataset/paths

### Description
Retrieves the paths of knowledge bases.

### Method
GET

### Endpoint
/core/dataset/paths

## GET /core/dataset/detail

### Description
Retrieves the details of a specific knowledge base.

### Method
GET

### Endpoint
/core/dataset/detail

## DELETE /core/dataset/delete

### Description
Deletes a knowledge base.

### Method
DELETE

### Endpoint
/core/dataset/delete

## PUT /core/dataset/update

### Description
Updates an existing knowledge base.

### Method
PUT

### Endpoint
/core/dataset/update

## PUT /core/dataset/resumeInheritPermission

### Description
Resumes inherited permissions for a knowledge base.

### Method
PUT

### Endpoint
/core/dataset/resumeInheritPermission

## POST /core/dataset/searchTest

### Description
Tests the search functionality for a knowledge base.

### Method
POST

### Endpoint
/core/dataset/searchTest

## GET /core/dataset/exportAll

### Description
Exports all data from a knowledge base.

### Method
GET

### Endpoint
/core/dataset/exportAll

## GET /core/dataset/getPermission

### Description
Retrieves the permission settings for a knowledge base.

### Method
GET

### Endpoint
/core/dataset/getPermission
```

--------------------------------

### Portal Page Configuration API

Source: https://cloud.fastgpt.cn/openapi

Endpoints for configuring the portal page.

```APIDOC
## GET /proApi/core/chat/setting/detail

### Description
Retrieves the detail configuration of the portal page.

### Method
GET

### Endpoint
/proApi/core/chat/setting/detail

### Parameters
#### Query Parameters
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## POST /proApi/core/chat/setting/update

### Description
Updates the portal page configuration.

### Method
POST

### Endpoint
/proApi/core/chat/setting/update

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## GET /proApi/core/chat/setting/favourite/list

### Description
Lists favorite items for the portal page.

### Method
GET

### Endpoint
/proApi/core/chat/setting/favourite/list

### Parameters
#### Query Parameters
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## POST /proApi/core/chat/setting/favourite/update

### Description
Updates a favorite item for the portal page.

### Method
POST

### Endpoint
/proApi/core/chat/setting/favourite/update

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## PUT /proApi/core/chat/setting/favourite/order

### Description
Updates the order of favorite items for the portal page.

### Method
PUT

### Endpoint
/proApi/core/chat/setting/favourite/order

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## PUT /proApi/core/chat/setting/favourite/tags

### Description
Updates tags for favorite items on the portal page.

### Method
PUT

### Endpoint
/proApi/core/chat/setting/favourite/tags

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## DELETE /proApi/core/chat/setting/favourite/delete

### Description
Deletes a favorite item from the portal page.

### Method
DELETE

### Endpoint
/proApi/core/chat/setting/favourite/delete

### Parameters
#### Query Parameters
- **param1** (type) - Required/Optional - Description
```

--------------------------------

### File Management API

Source: https://cloud.fastgpt.cn/openapi

APIs for managing files, including previewing chunks and obtaining pre-signed URLs for uploads.

```APIDOC
## POST /core/dataset/file/getPreviewChunks

### Description
Retrieves preview chunks for a file.

### Method
POST

### Endpoint
/core/dataset/file/getPreviewChunks

## POST /core/dataset/file/presignDatasetFilePostUrl

### Description
Generates a pre-signed URL for uploading a dataset file.

### Method
POST

### Endpoint
/core/dataset/file/presignDatasetFilePostUrl
```

--------------------------------

### Coupon API

Source: https://cloud.fastgpt.cn/openapi

API for retrieving a list of available coupons.

```APIDOC
## GET /support/wallet/discountCoupon/list

### Description
Retrieves a list of available discount coupons.

### Method
GET

### Endpoint
/support/wallet/discountCoupon/list
```

--------------------------------

### AI Sandbox API

Source: https://cloud.fastgpt.cn/openapi

Endpoints for interacting with the AI sandbox.

```APIDOC
## POST /core/ai/sandbox/list

### Description
Lists items in the AI sandbox.

### Method
POST

### Endpoint
/core/ai/sandbox/list

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## POST /core/ai/sandbox/write

### Description
Writes data to the AI sandbox.

### Method
POST

### Endpoint
/core/ai/sandbox/write

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## POST /core/ai/sandbox/read

### Description
Reads data from the AI sandbox.

### Method
POST

### Endpoint
/core/ai/sandbox/read

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## POST /core/ai/sandbox/download

### Description
Downloads data from the AI sandbox.

### Method
POST

### Endpoint
/core/ai/sandbox/download

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## POST /core/ai/sandbox/getHtmlPreviewLink

### Description
Gets an HTML preview link for content in the AI sandbox.

### Method
POST

### Endpoint
/core/ai/sandbox/getHtmlPreviewLink

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## POST /core/ai/sandbox/checkExist

### Description
Checks if an item exists in the AI sandbox.

### Method
POST

### Endpoint
/core/ai/sandbox/checkExist

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

--------------------------------

### User Account API

Source: https://cloud.fastgpt.cn/openapi

APIs for managing user accounts, including login, registration, password management, and token-based authentication.

```APIDOC
## GET /support/user/account/tokenLogin

### Description
Logs in a user using a token.

### Method
GET

### Endpoint
/support/user/account/tokenLogin

## GET /support/user/account/preLogin

### Description
Initiates the pre-login process.

### Method
GET

### Endpoint
/support/user/account/preLogin

## POST /support/user/account/loginByPassword

### Description
Logs in a user with their password.

### Method
POST

### Endpoint
/support/user/account/loginByPassword

## POST /proApi/support/user/account/login/oauth

### Description
Logs in a user via OAuth.

### Method
POST

### Endpoint
/proApi/support/user/account/login/oauth

## POST /proApi/support/user/account/login/fastLogin

### Description
Performs a fast login for the user.

### Method
POST

### Endpoint
/proApi/support/user/account/login/fastLogin

## GET /proApi/support/user/account/login/wx/getQR

### Description
Gets the QR code for WeChat login.

### Method
GET

### Endpoint
/proApi/support/user/account/login/wx/getQR

## POST /proApi/support/user/account/login/wx/getResult

### Description
Gets the result of a WeChat login attempt.

### Method
POST

### Endpoint
/proApi/support/user/account/login/wx/getResult

## GET /support/user/account/loginout

### Description
Logs the user out.

### Method
GET

### Endpoint
/support/user/account/loginout

## POST /support/user/account/register/emailAndPhone

### Description
Registers a new user with email and phone number.

### Method
POST

### Endpoint
/support/user/account/register/emailAndPhone

## POST /support/user/account/updatePasswordByOld

### Description
Updates the user's password using the old password.

### Method
POST

### Endpoint
/support/user/account/updatePasswordByOld

## GET /support/user/account/checkPswExpired

### Description
Checks if the user's password has expired.

### Method
GET

### Endpoint
/support/user/account/checkPswExpired

## POST /support/user/account/resetExpiredPsw

### Description
Resets an expired user password.

### Method
POST

### Endpoint
/support/user/account/resetExpiredPsw

## POST /support/user/account/password/updateByCode

### Description
Updates the user's password using a code.

### Method
POST

### Endpoint
/support/user/account/password/updateByCode
```

--------------------------------

### HTTP Tool Management API

Source: https://cloud.fastgpt.cn/openapi

Endpoints for managing HTTP tools.

```APIDOC
## POST /core/app/httpTools/create

### Description
Creates an HTTP tool.

### Method
POST

### Endpoint
/core/app/httpTools/create

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## POST /core/app/httpTools/update

### Description
Updates an HTTP tool.

### Method
POST

### Endpoint
/core/app/httpTools/update

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## POST /core/app/httpTools/getApiSchemaByUrl

### Description
Retrieves the API schema from a URL.

### Method
POST

### Endpoint
/core/app/httpTools/getApiSchemaByUrl

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## POST /core/app/httpTools/runTool

### Description
Runs an HTTP tool.

### Method
POST

### Endpoint
/core/app/httpTools/runTool

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

--------------------------------

### Application Permissions API

Source: https://cloud.fastgpt.cn/openapi

Endpoints for managing application permissions.

```APIDOC
## GET /core/app/getPermission

### Description
Retrieves application permissions.

### Method
GET

### Endpoint
/core/app/getPermission

### Parameters
#### Query Parameters
- **param1** (type) - Required/Optional - Description
```

--------------------------------

### Order API

Source: https://cloud.fastgpt.cn/openapi

APIs for managing orders, including creation, payment updates, status checks, and retrieval.

```APIDOC
## POST /support/wallet/bill/create

### Description
Creates a new order.

### Method
POST

### Endpoint
/support/wallet/bill/create

## POST /support/wallet/bill/pay/updatePayment

### Description
Updates the payment status of an order.

### Method
POST

### Endpoint
/support/wallet/bill/pay/updatePayment

## GET /support/wallet/bill/pay/checkPayResult

### Description
Checks the payment result of an order.

### Method
GET

### Endpoint
/support/wallet/bill/pay/checkPayResult

## GET /support/wallet/bill/detail

### Description
Retrieves the details of a specific order.

### Method
GET

### Endpoint
/support/wallet/bill/detail

## POST /support/wallet/bill/list

### Description
Retrieves a list of orders.

### Method
POST

### Endpoint
/support/wallet/bill/list

## POST /support/wallet/bill/cancel

### Description
Cancels an order.

### Method
POST

### Endpoint
/support/wallet/bill/cancel
```

--------------------------------

### Tool Tag API

Source: https://cloud.fastgpt.cn/openapi

API for listing available tool tags.

```APIDOC
## GET /core/plugin/toolTag/list

### Description
Retrieves a list of tool tags.

### Method
GET

### Endpoint
/core/plugin/toolTag/list
```

--------------------------------

### AI Skill Management API

Source: https://cloud.fastgpt.cn/openapi

Endpoints for managing AI skills.

```APIDOC
## POST /core/agentSkills/list

### Description
Lists AI skills.

### Method
POST

### Endpoint
/core/agentSkills/list

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## GET /core/agentSkills/detail

### Description
Retrieves the details of an AI skill.

### Method
GET

### Endpoint
/core/agentSkills/detail

### Parameters
#### Query Parameters
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## POST /core/agentSkills/create

### Description
Creates a new AI skill.

### Method
POST

### Endpoint
/core/agentSkills/create

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## POST /core/agentSkills/update

### Description
Updates an existing AI skill.

### Method
POST

### Endpoint
/core/agentSkills/update

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## DELETE /core/agentSkills/delete

### Description
Deletes an AI skill.

### Method
DELETE

### Endpoint
/core/agentSkills/delete

### Parameters
#### Query Parameters
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## POST /core/agentSkills/import

### Description
Imports an AI skill.

### Method
POST

### Endpoint
/core/agentSkills/import

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## GET /core/agentSkills/export

### Description
Exports an AI skill.

### Method
GET

### Endpoint
/core/agentSkills/export

### Parameters
#### Query Parameters
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## GET /core/agentSkills/apps

### Description
Retrieves applications associated with an AI skill.

### Method
GET

### Endpoint
/core/agentSkills/apps

### Parameters
#### Query Parameters
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## POST /core/agentSkills/folder/create

### Description
Creates a folder for AI skills.

### Method
POST

### Endpoint
/core/agentSkills/folder/create

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## GET /core/agentSkills/folder/path

### Description
Retrieves the path of an AI skill folder.

### Method
GET

### Endpoint
/core/agentSkills/folder/path

### Parameters
#### Query Parameters
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## POST /core/agentSkills/edit

### Description
Edits an AI skill.

### Method
POST

### Endpoint
/core/agentSkills/edit

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## POST /core/agentSkills/save-deploy

### Description
Saves and deploys an AI skill.

### Method
POST

### Endpoint
/core/agentSkills/save-deploy

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## POST /core/agentSkills/debugChat

### Description
Debugs an AI skill chat.

### Method
POST

### Endpoint
/core/agentSkills/debugChat

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## GET /core/agentSkills/debugSession/list

### Description
Lists debug sessions for an AI skill.

### Method
GET

### Endpoint
/core/agentSkills/debugSession/list

### Parameters
#### Query Parameters
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## POST /core/agentSkills/debugSession/delete

### Description
Deletes a debug session for an AI skill.

### Method
POST

### Endpoint
/core/agentSkills/debugSession/delete

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## POST /core/agentSkills/debugSession/records

### Description
Retrieves records for an AI skill debug session.

### Method
POST

### Endpoint
/core/agentSkills/debugSession/records

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## POST /core/agentSkills/version/list

### Description
Lists versions of an AI skill.

### Method
POST

### Endpoint
/core/agentSkills/version/list

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## POST /core/agentSkills/version/update

### Description
Updates a version of an AI skill.

### Method
POST

### Endpoint
/core/agentSkills/version/update

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## POST /core/agentSkills/version/switch

### Description
Switches the active version of an AI skill.

### Method
POST

### Endpoint
/core/agentSkills/version/switch

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

--------------------------------

### Training Management API

Source: https://cloud.fastgpt.cn/openapi

APIs for managing the training process of datasets, including updating training data, rebuilding embeddings, and checking training status.

```APIDOC
## PUT /core/dataset/training/updateTrainingData

### Description
Updates training data for a dataset.

### Method
PUT

### Endpoint
/core/dataset/training/updateTrainingData

## POST /core/dataset/training/rebuildEmbedding

### Description
Rebuilds embeddings for a dataset.

### Method
POST

### Endpoint
/core/dataset/training/rebuildEmbedding

## DELETE /core/dataset/training/deleteTrainingData

### Description
Deletes training data for a dataset.

### Method
DELETE

### Endpoint
/core/dataset/training/deleteTrainingData

## POST /core/dataset/training/getTrainingDataDetail

### Description
Retrieves details of training data.

### Method
POST

### Endpoint
/core/dataset/training/getTrainingDataDetail

## POST /core/dataset/training/getTrainingError

### Description
Retrieves training errors.

### Method
POST

### Endpoint
/core/dataset/training/getTrainingError

## GET /core/dataset/training/getDatasetTrainingQueue

### Description
Retrieves the dataset training queue status.

### Method
GET

### Endpoint
/core/dataset/training/getDatasetTrainingQueue
```

--------------------------------

### MCP Tool Management API

Source: https://cloud.fastgpt.cn/openapi

Endpoints for managing MCP tools.

```APIDOC
## POST /core/app/mcpTools/getTools

### Description
Retrieves MCP tools.

### Method
POST

### Endpoint
/core/app/mcpTools/getTools

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## POST /core/app/mcpTools/runTool

### Description
Runs an MCP tool.

### Method
POST

### Endpoint
/core/app/mcpTools/runTool

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## POST /core/app/mcpTools/create

### Description
Creates an MCP tool.

### Method
POST

### Endpoint
/core/app/mcpTools/create

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## POST /core/app/mcpTools/update

### Description
Updates an MCP tool.

### Method
POST

### Endpoint
/core/app/mcpTools/update

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## GET /core/app/mcpTools/getChildren

### Description
Retrieves children of an MCP tool.

### Method
GET

### Endpoint
/core/app/mcpTools/getChildren

### Parameters
#### Query Parameters
- **param1** (type) - Required/Optional - Description
```

--------------------------------

### MCP Release Management API

Source: https://cloud.fastgpt.cn/openapi

Endpoints for managing MCP releases.

```APIDOC
## GET /support/mcp/list

### Description
Lists MCP releases.

### Method
GET

### Endpoint
/support/mcp/list

### Parameters
#### Query Parameters
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## POST /support/mcp/create

### Description
Creates a new MCP release.

### Method
POST

### Endpoint
/support/mcp/create

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## PUT /support/mcp/update

### Description
Updates an existing MCP release.

### Method
PUT

### Endpoint
/support/mcp/update

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## DELETE /support/mcp/delete

### Description
Deletes an MCP release.

### Method
DELETE

### Endpoint
/support/mcp/delete

### Parameters
#### Query Parameters
- **param1** (type) - Required/Optional - Description
```

--------------------------------

### Publish Channel API

Source: https://cloud.fastgpt.cn/openapi

Endpoints for managing publish channels.

```APIDOC
## GET /api/support/outLink/playground/config

### Description
Retrieves the playground configuration for an external link.

### Method
GET

### Endpoint
/api/support/outLink/playground/config

### Parameters
#### Query Parameters
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## POST /api/support/outLink/playground/update

### Description
Updates the playground configuration for an external link.

### Method
POST

### Endpoint
/api/support/outLink/playground/update

### Parameters
#### Request Body
- **param1** (type) - Required/Optional - Description
```

```APIDOC
## GET /support/outLink/list

### Description
Lists available external links.

### Method
GET

### Endpoint
/support/outLink/list

### Parameters
#### Query Parameters
- **param1** (type) - Required/Optional - Description
```

--------------------------------

### Collection Management API

Source: https://cloud.fastgpt.cn/openapi

APIs for managing collections within knowledge bases, including deletion, retrieval, listing, and synchronization.

```APIDOC
## DELETE /core/dataset/collection/delete

### Description
Deletes a collection.

### Method
DELETE

### Endpoint
/core/dataset/collection/delete

## GET /core/dataset/collection/detail

### Description
Retrieves the details of a specific collection.

### Method
GET

### Endpoint
/core/dataset/collection/detail

## POST /core/dataset/collection/listV2

### Description
Retrieves a list of collections (version 2).

### Method
POST

### Endpoint
/core/dataset/collection/listV2

## POST /core/dataset/collection/scrollList

### Description
Retrieves a paginated list of collections using scrolling.

### Method
POST

### Endpoint
/core/dataset/collection/scrollList

## POST /core/dataset/collection/update

### Description
Updates an existing collection.

### Method
POST

### Endpoint
/core/dataset/collection/update

## GET /core/dataset/collection/paths

### Description
Retrieves the paths of collections.

### Method
GET

### Endpoint
/core/dataset/collection/paths

## POST /core/dataset/collection/read

### Description
Reads data from a collection.

### Method
POST

### Endpoint
/core/dataset/collection/read

## POST /core/dataset/collection/sync

### Description
Synchronizes a collection.

### Method
POST

### Endpoint
/core/dataset/collection/sync

## POST /core/dataset/collection/export

### Description
Exports a collection.

### Method
POST

### Endpoint
/core/dataset/collection/export

## GET /core/dataset/collection/trainingDetail

### Description
Retrieves the training details for a collection.

### Method
GET

### Endpoint
/core/dataset/collection/trainingDetail
```

--------------------------------

### API Dataset Management API

Source: https://cloud.fastgpt.cn/openapi

APIs for managing datasets that are sourced from APIs, including listing and retrieving catalog information.

```APIDOC
## POST /core/dataset/apiDataset/getCatalog

### Description
Retrieves the catalog for API datasets.

### Method
POST

### Endpoint
/core/dataset/apiDataset/getCatalog

## POST /core/dataset/apiDataset/getPathNames

### Description
Retrieves path names for API datasets.

### Method
POST

### Endpoint
/core/dataset/apiDataset/getPathNames

## POST /core/dataset/apiDataset/list

### Description
Retrieves a list of API datasets.

### Method
POST

### Endpoint
/core/dataset/apiDataset/list

## GET /core/dataset/apiDataset/listExistId

### Description
Retrieves a list of existing API dataset IDs.

### Method
GET

### Endpoint
/core/dataset/apiDataset/listExistId
```