資料庫

建立 SQL 資料庫連線

POST /api/v1/sql-databases/

請求內容

請求參數

欄位	類型	必填	說明
name	string	是	Display name for this database connection
description	string	否	Description of the database and its purpose
databaseType	object	是	Type of database: PostgreSQL, MySQL, MSSQL, Oracle, or MaiAgent postgresql: PostgreSQL ; mysql: MySQL ; maiagent: MaiAgent ; oracle: Oracle ; mssql: MSSQL;
databaseUrl	string	否	Connection string for external databases. Not required for MaiAgent type as it uses the system default.
includeTables	object	否	Optional list of tables to include. Format: {"tables": ["table1", "table2"]}. For MaiAgent type, this is auto-populated from uploaded files.
isActive	boolean	否	When disabled, this database will not be used in Text-to-SQL queries
chatbots	array[IdName]	否
groups	array[IdName]	否

請求結構範例

{
  "name": string // Display name for this database connection
  "description"?: string // Description of the database and its purpose (非必填)
  "databaseType":  // Type of database: PostgreSQL, MySQL, MSSQL, Oracle, or MaiAgent

* `postgresql` - PostgreSQL
* `mysql` - MySQL
* `maiagent` - MaiAgent
* `oracle` - Oracle
* `mssql` - MSSQL
  {
  }
  "databaseUrl"?: string // Connection string for external databases. Not required for MaiAgent type as it uses the system default. (非必填)
  "includeTables"?: object // Optional list of tables to include. Format: {"tables": ["table1", "table2"]}. For MaiAgent type, this is auto-populated from uploaded files. (非必填)
  "isActive"?: boolean // When disabled, this database will not be used in Text-to-SQL queries (非必填)
  "chatbots"?: [ // 非必填
    {
      "id": string (uuid)
    }
  ]
  "groups"?: [ // 非必填
    {
      "id": string (uuid)
    }
  ]
}

請求範例值

{
  "name": "範例名稱",
  "description": "範例字串",
  "databaseType": {},
  "databaseUrl": "範例字串",
  "includeTables": null,
  "isActive": true,
  "chatbots": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "groups": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ]
}

程式碼範例

Shell/Bash

# 呼叫 API 示例 (Shell)
curl -X POST "https://api.maiagent.ai/api/v1/sql-databases/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "範例名稱",
    "description": "範例字串",
    "databaseType": {},
    "databaseUrl": "範例字串",
    "includeTables": null,
    "isActive": true,
    "chatbots": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "groups": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ]
  }'

# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。

JavaScript

Python

PHP

回應內容

狀態碼: 201

回應結構範例

{
  "id": string (uuid)
  "name": string // Display name for this database connection
  "description"?: string // Description of the database and its purpose (非必填)
  "databaseType":  // Type of database: PostgreSQL, MySQL, MSSQL, Oracle, or MaiAgent

* `postgresql` - PostgreSQL
* `mysql` - MySQL
* `maiagent` - MaiAgent
* `oracle` - Oracle
* `mssql` - MSSQL
  {
  }
  "databaseUrl"?: string // Connection string for external databases. Not required for MaiAgent type as it uses the system default. (非必填)
  "includeTables"?: object // Optional list of tables to include. Format: {"tables": ["table1", "table2"]}. For MaiAgent type, this is auto-populated from uploaded files. (非必填)
  "isActive"?: boolean // When disabled, this database will not be used in Text-to-SQL queries (非必填)
  "status": 
  {
  }
  "deletedAt": string (timestamp)
  "tables": [
    {
      "id": string (uuid)
      "tableName": string // Name of the table in the database
      "description"?: string // Description of the table and its data for better Text-to-SQL understanding (非必填)
      "status": 
      {
      }
      "errorMessage": string // Error details if table creation or deletion failed
      "sourceFile": 
      {
        "id": string (uuid)
        "name": string
        "isFromKnowledgeBase": boolean // Determine if the source file originated from a knowledge base upload.

Returns True if the file was uploaded via knowledge base,
False if uploaded directly to the database.
      }
      "columns": [
        {
          "id": string (uuid)
          "columnName": string
          "columnType"?: string // Data type of the column (e.g., VARCHAR, INTEGER, TIMESTAMP) (非必填)
          "description"?: string // Description of the column for better Text-to-SQL understanding (非必填)
          "isPrimaryKey"?: boolean // 非必填
          "isNullable"?: boolean // 非必填
          "createdAt": string (timestamp)
          "updatedAt": string (timestamp)
        }
      ]
      "createdAt": string (timestamp)
      "updatedAt": string (timestamp)
    }
  ]
  "chatbots": [
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "groups": [
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "createdBy": 
  {
    "id": string (uuid)
    "name": string
  }
  "canUpdate": boolean // Return whether the current user can update this resource.
  "canDelete": boolean // Return whether the current user can delete this resource.
  "createdAt": string (timestamp)
  "updatedAt": string (timestamp)
}

回應範例值

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "回應字串",
  "description": "回應字串",
  "databaseType": {},
  "databaseUrl": "回應字串",
  "includeTables": null,
  "isActive": false,
  "status": {},
  "deletedAt": "回應字串",
  "tables": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "tableName": "回應字串",
      "description": "回應字串",
      "status": {},
      "errorMessage": "回應字串",
      "sourceFile": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "回應字串",
        "isFromKnowledgeBase": false
      },
      "columns": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "columnName": "回應字串",
          "columnType": "回應字串",
          "description": "回應字串",
          "isPrimaryKey": false,
          "isNullable": false,
          "createdAt": "回應字串",
          "updatedAt": "回應字串"
        }
      ],
      "createdAt": "回應字串",
      "updatedAt": "回應字串"
    }
  ],
  "chatbots": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "回應字串"
    }
  ],
  "groups": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "回應字串"
    }
  ],
  "createdBy": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "回應字串"
  },
  "canUpdate": false,
  "canDelete": false,
  "createdAt": "回應字串",
  "updatedAt": "回應字串"
}

---

列出 SQL 資料庫

GET /api/v1/sql-databases/

參數

參數名稱	必填	類型	說明
databaseType	❌	string	Type of database: PostgreSQL, MySQL, MSSQL, Oracle, or MaiAgent `postgresql`: PostgreSQL ; `mysql`: MySQL ; `maiagent`: MaiAgent ; `oracle`: Oracle ; `mssql`: MSSQL;
isActive	❌	boolean
isExternal	❌	boolean
page	❌	integer	A page number within the paginated result set.
pageSize	❌	integer	Number of results to return per page.
query	❌	string

程式碼範例

Shell/Bash

# 呼叫 API 示例 (Shell)
curl -X GET "https://api.maiagent.ai/api/v1/sql-databases/?databaseType=maiagent&isActive=true&isExternal=true&page=1&pageSize=1&query=example" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。

JavaScript

Python

PHP

回應內容

狀態碼: 200

回應結構範例

{
  "count": integer
  "next"?: string (uri) // 非必填
  "previous"?: string (uri) // 非必填
  "results": [
    {
      "id": string (uuid)
      "name": string // Display name for this database connection
      "description"?: string // Description of the database and its purpose (非必填)
      "databaseType":  // Type of database: PostgreSQL, MySQL, MSSQL, Oracle, or MaiAgent

* `postgresql` - PostgreSQL
* `mysql` - MySQL
* `maiagent` - MaiAgent
* `oracle` - Oracle
* `mssql` - MSSQL
      {
      }
      "databaseUrl"?: string // Connection string for external databases. Not required for MaiAgent type as it uses the system default. (非必填)
      "includeTables"?: object // Optional list of tables to include. Format: {"tables": ["table1", "table2"]}. For MaiAgent type, this is auto-populated from uploaded files. (非必填)
      "isActive"?: boolean // When disabled, this database will not be used in Text-to-SQL queries (非必填)
      "status": 
      {
      }
      "deletedAt": string (timestamp)
      "tables": [
        {
          "id": string (uuid)
          "tableName": string // Name of the table in the database
        }
      ]
      "tablesCount": integer
      "chatbots": [
        {
          "id": string (uuid)
          "name": string
        }
      ]
      "groups": [
        {
          "id": string (uuid)
          "name": string
        }
      ]
      "createdBy": 
      {
        "id": string (uuid)
        "name": string
      }
      "canUpdate": boolean // Return whether the current user can update this resource.
      "canDelete": boolean // Return whether the current user can delete this resource.
      "createdAt": string (timestamp)
      "updatedAt": string (timestamp)
    }
  ]
}

回應範例值

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "回應字串",
      "description": "回應字串",
      "databaseType": {},
      "databaseUrl": "回應字串",
      "includeTables": null,
      "isActive": false,
      "status": {},
      "deletedAt": "回應字串",
      "tables": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "tableName": "回應字串"
        }
      ],
      "tablesCount": 456,
      "chatbots": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "回應字串"
        }
      ],
      "groups": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "回應字串"
        }
      ],
      "createdBy": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "回應字串"
      },
      "canUpdate": false,
      "canDelete": false,
      "createdAt": "回應字串",
      "updatedAt": "回應字串"
    }
  ]
}

---

取得特定 SQL 資料庫

GET /api/v1/sql-databases/{id}/

參數

參數名稱	必填	類型	說明
id	✅	string	A UUID string identifying this SQL Database.

程式碼範例

Shell/Bash

# 呼叫 API 示例 (Shell)
curl -X GET "https://api.maiagent.ai/api/v1/sql-databases/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。

JavaScript

Python

PHP

回應內容

狀態碼: 200

回應結構範例

{
  "id": string (uuid)
  "name": string // Display name for this database connection
  "description"?: string // Description of the database and its purpose (非必填)
  "databaseType":  // Type of database: PostgreSQL, MySQL, MSSQL, Oracle, or MaiAgent

* `postgresql` - PostgreSQL
* `mysql` - MySQL
* `maiagent` - MaiAgent
* `oracle` - Oracle
* `mssql` - MSSQL
  {
  }
  "databaseUrl"?: string // Connection string for external databases. Not required for MaiAgent type as it uses the system default. (非必填)
  "includeTables"?: object // Optional list of tables to include. Format: {"tables": ["table1", "table2"]}. For MaiAgent type, this is auto-populated from uploaded files. (非必填)
  "isActive"?: boolean // When disabled, this database will not be used in Text-to-SQL queries (非必填)
  "status": 
  {
  }
  "deletedAt": string (timestamp)
  "tables": [
    {
      "id": string (uuid)
      "tableName": string // Name of the table in the database
      "description"?: string // Description of the table and its data for better Text-to-SQL understanding (非必填)
      "status": 
      {
      }
      "errorMessage": string // Error details if table creation or deletion failed
      "sourceFile": 
      {
        "id": string (uuid)
        "name": string
        "isFromKnowledgeBase": boolean // Determine if the source file originated from a knowledge base upload.

Returns True if the file was uploaded via knowledge base,
False if uploaded directly to the database.
      }
      "columns": [
        {
          "id": string (uuid)
          "columnName": string
          "columnType"?: string // Data type of the column (e.g., VARCHAR, INTEGER, TIMESTAMP) (非必填)
          "description"?: string // Description of the column for better Text-to-SQL understanding (非必填)
          "isPrimaryKey"?: boolean // 非必填
          "isNullable"?: boolean // 非必填
          "createdAt": string (timestamp)
          "updatedAt": string (timestamp)
        }
      ]
      "createdAt": string (timestamp)
      "updatedAt": string (timestamp)
    }
  ]
  "chatbots": [
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "groups": [
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "createdBy": 
  {
    "id": string (uuid)
    "name": string
  }
  "canUpdate": boolean // Return whether the current user can update this resource.
  "canDelete": boolean // Return whether the current user can delete this resource.
  "createdAt": string (timestamp)
  "updatedAt": string (timestamp)
}

回應範例值

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "回應字串",
  "description": "回應字串",
  "databaseType": {},
  "databaseUrl": "回應字串",
  "includeTables": null,
  "isActive": false,
  "status": {},
  "deletedAt": "回應字串",
  "tables": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "tableName": "回應字串",
      "description": "回應字串",
      "status": {},
      "errorMessage": "回應字串",
      "sourceFile": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "回應字串",
        "isFromKnowledgeBase": false
      },
      "columns": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "columnName": "回應字串",
          "columnType": "回應字串",
          "description": "回應字串",
          "isPrimaryKey": false,
          "isNullable": false,
          "createdAt": "回應字串",
          "updatedAt": "回應字串"
        }
      ],
      "createdAt": "回應字串",
      "updatedAt": "回應字串"
    }
  ],
  "chatbots": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "回應字串"
    }
  ],
  "groups": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "回應字串"
    }
  ],
  "createdBy": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "回應字串"
  },
  "canUpdate": false,
  "canDelete": false,
  "createdAt": "回應字串",
  "updatedAt": "回應字串"
}

---

更新 SQL 資料庫

PUT /api/v1/sql-databases/{id}/

參數

參數名稱	必填	類型	說明
id	✅	string	A UUID string identifying this SQL Database.

請求內容

請求參數

欄位	類型	必填	說明
name	string	是	Display name for this database connection
description	string	否	Description of the database and its purpose
databaseUrl	string	否	Connection string for external databases. Not required for MaiAgent type as it uses the system default.
includeTables	object	否	Optional list of tables to include. Format: {"tables": ["table1", "table2"]}. For MaiAgent type, this is auto-populated from uploaded files.
isActive	boolean	否	When disabled, this database will not be used in Text-to-SQL queries
chatbots	array[IdName]	否
groups	array[IdName]	否

請求結構範例

{
  "name": string // Display name for this database connection
  "description"?: string // Description of the database and its purpose (非必填)
  "databaseUrl"?: string // Connection string for external databases. Not required for MaiAgent type as it uses the system default. (非必填)
  "includeTables"?: object // Optional list of tables to include. Format: {"tables": ["table1", "table2"]}. For MaiAgent type, this is auto-populated from uploaded files. (非必填)
  "isActive"?: boolean // When disabled, this database will not be used in Text-to-SQL queries (非必填)
  "chatbots"?: [ // 非必填
    {
      "id": string (uuid)
    }
  ]
  "groups"?: [ // 非必填
    {
      "id": string (uuid)
    }
  ]
}

請求範例值

{
  "name": "範例名稱",
  "description": "範例字串",
  "databaseUrl": "範例字串",
  "includeTables": null,
  "isActive": true,
  "chatbots": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "groups": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ]
}

程式碼範例

Shell/Bash

# 呼叫 API 示例 (Shell)
curl -X PUT "https://api.maiagent.ai/api/v1/sql-databases/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "範例名稱",
    "description": "範例字串",
    "databaseUrl": "範例字串",
    "includeTables": null,
    "isActive": true,
    "chatbots": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "groups": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ]
  }'

# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。

JavaScript

Python

PHP

回應內容

狀態碼: 200

回應結構範例

{
  "id": string (uuid)
  "name": string // Display name for this database connection
  "description"?: string // Description of the database and its purpose (非必填)
  "databaseType":  // Type of database: PostgreSQL, MySQL, MSSQL, Oracle, or MaiAgent

* `postgresql` - PostgreSQL
* `mysql` - MySQL
* `maiagent` - MaiAgent
* `oracle` - Oracle
* `mssql` - MSSQL
  {
  }
  "databaseUrl"?: string // Connection string for external databases. Not required for MaiAgent type as it uses the system default. (非必填)
  "includeTables"?: object // Optional list of tables to include. Format: {"tables": ["table1", "table2"]}. For MaiAgent type, this is auto-populated from uploaded files. (非必填)
  "isActive"?: boolean // When disabled, this database will not be used in Text-to-SQL queries (非必填)
  "status": 
  {
  }
  "deletedAt": string (timestamp)
  "tables": [
    {
      "id": string (uuid)
      "tableName": string // Name of the table in the database
      "description"?: string // Description of the table and its data for better Text-to-SQL understanding (非必填)
      "status": 
      {
      }
      "errorMessage": string // Error details if table creation or deletion failed
      "sourceFile": 
      {
        "id": string (uuid)
        "name": string
        "isFromKnowledgeBase": boolean // Determine if the source file originated from a knowledge base upload.

Returns True if the file was uploaded via knowledge base,
False if uploaded directly to the database.
      }
      "columns": [
        {
          "id": string (uuid)
          "columnName": string
          "columnType"?: string // Data type of the column (e.g., VARCHAR, INTEGER, TIMESTAMP) (非必填)
          "description"?: string // Description of the column for better Text-to-SQL understanding (非必填)
          "isPrimaryKey"?: boolean // 非必填
          "isNullable"?: boolean // 非必填
          "createdAt": string (timestamp)
          "updatedAt": string (timestamp)
        }
      ]
      "createdAt": string (timestamp)
      "updatedAt": string (timestamp)
    }
  ]
  "chatbots": [
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "groups": [
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "createdBy": 
  {
    "id": string (uuid)
    "name": string
  }
  "canUpdate": boolean // Return whether the current user can update this resource.
  "canDelete": boolean // Return whether the current user can delete this resource.
  "createdAt": string (timestamp)
  "updatedAt": string (timestamp)
}

回應範例值

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "回應字串",
  "description": "回應字串",
  "databaseType": {},
  "databaseUrl": "回應字串",
  "includeTables": null,
  "isActive": false,
  "status": {},
  "deletedAt": "回應字串",
  "tables": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "tableName": "回應字串",
      "description": "回應字串",
      "status": {},
      "errorMessage": "回應字串",
      "sourceFile": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "回應字串",
        "isFromKnowledgeBase": false
      },
      "columns": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "columnName": "回應字串",
          "columnType": "回應字串",
          "description": "回應字串",
          "isPrimaryKey": false,
          "isNullable": false,
          "createdAt": "回應字串",
          "updatedAt": "回應字串"
        }
      ],
      "createdAt": "回應字串",
      "updatedAt": "回應字串"
    }
  ],
  "chatbots": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "回應字串"
    }
  ],
  "groups": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "回應字串"
    }
  ],
  "createdBy": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "回應字串"
  },
  "canUpdate": false,
  "canDelete": false,
  "createdAt": "回應字串",
  "updatedAt": "回應字串"
}

---

部分更新 SQL 資料庫

PATCH /api/v1/sql-databases/{id}/

參數

參數名稱	必填	類型	說明
id	✅	string	A UUID string identifying this SQL Database.

請求內容

請求參數

欄位	類型	必填	說明
name	string	否	Display name for this database connection
description	string	否	Description of the database and its purpose
databaseUrl	string	否	Connection string for external databases. Not required for MaiAgent type as it uses the system default.
includeTables	object	否	Optional list of tables to include. Format: {"tables": ["table1", "table2"]}. For MaiAgent type, this is auto-populated from uploaded files.
isActive	boolean	否	When disabled, this database will not be used in Text-to-SQL queries
chatbots	array[IdName]	否
groups	array[IdName]	否

請求結構範例

{
  "name"?: string // Display name for this database connection (非必填)
  "description"?: string // Description of the database and its purpose (非必填)
  "databaseUrl"?: string // Connection string for external databases. Not required for MaiAgent type as it uses the system default. (非必填)
  "includeTables"?: object // Optional list of tables to include. Format: {"tables": ["table1", "table2"]}. For MaiAgent type, this is auto-populated from uploaded files. (非必填)
  "isActive"?: boolean // When disabled, this database will not be used in Text-to-SQL queries (非必填)
  "chatbots"?: [ // 非必填
    {
      "id": string (uuid)
    }
  ]
  "groups"?: [ // 非必填
    {
      "id": string (uuid)
    }
  ]
}

請求範例值

{
  "name": "範例名稱",
  "description": "範例字串",
  "databaseUrl": "範例字串",
  "includeTables": null,
  "isActive": true,
  "chatbots": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "groups": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ]
}

程式碼範例

Shell/Bash

# 呼叫 API 示例 (Shell)
curl -X PATCH "https://api.maiagent.ai/api/v1/sql-databases/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "範例名稱",
    "description": "範例字串",
    "databaseUrl": "範例字串",
    "includeTables": null,
    "isActive": true,
    "chatbots": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "groups": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ]
  }'

# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。

JavaScript

Python

PHP

回應內容

狀態碼: 200

回應結構範例

{
  "id": string (uuid)
  "name": string // Display name for this database connection
  "description"?: string // Description of the database and its purpose (非必填)
  "databaseType":  // Type of database: PostgreSQL, MySQL, MSSQL, Oracle, or MaiAgent

* `postgresql` - PostgreSQL
* `mysql` - MySQL
* `maiagent` - MaiAgent
* `oracle` - Oracle
* `mssql` - MSSQL
  {
  }
  "databaseUrl"?: string // Connection string for external databases. Not required for MaiAgent type as it uses the system default. (非必填)
  "includeTables"?: object // Optional list of tables to include. Format: {"tables": ["table1", "table2"]}. For MaiAgent type, this is auto-populated from uploaded files. (非必填)
  "isActive"?: boolean // When disabled, this database will not be used in Text-to-SQL queries (非必填)
  "status": 
  {
  }
  "deletedAt": string (timestamp)
  "tables": [
    {
      "id": string (uuid)
      "tableName": string // Name of the table in the database
      "description"?: string // Description of the table and its data for better Text-to-SQL understanding (非必填)
      "status": 
      {
      }
      "errorMessage": string // Error details if table creation or deletion failed
      "sourceFile": 
      {
        "id": string (uuid)
        "name": string
        "isFromKnowledgeBase": boolean // Determine if the source file originated from a knowledge base upload.

Returns True if the file was uploaded via knowledge base,
False if uploaded directly to the database.
      }
      "columns": [
        {
          "id": string (uuid)
          "columnName": string
          "columnType"?: string // Data type of the column (e.g., VARCHAR, INTEGER, TIMESTAMP) (非必填)
          "description"?: string // Description of the column for better Text-to-SQL understanding (非必填)
          "isPrimaryKey"?: boolean // 非必填
          "isNullable"?: boolean // 非必填
          "createdAt": string (timestamp)
          "updatedAt": string (timestamp)
        }
      ]
      "createdAt": string (timestamp)
      "updatedAt": string (timestamp)
    }
  ]
  "chatbots": [
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "groups": [
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "createdBy": 
  {
    "id": string (uuid)
    "name": string
  }
  "canUpdate": boolean // Return whether the current user can update this resource.
  "canDelete": boolean // Return whether the current user can delete this resource.
  "createdAt": string (timestamp)
  "updatedAt": string (timestamp)
}

回應範例值

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "回應字串",
  "description": "回應字串",
  "databaseType": {},
  "databaseUrl": "回應字串",
  "includeTables": null,
  "isActive": false,
  "status": {},
  "deletedAt": "回應字串",
  "tables": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "tableName": "回應字串",
      "description": "回應字串",
      "status": {},
      "errorMessage": "回應字串",
      "sourceFile": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "回應字串",
        "isFromKnowledgeBase": false
      },
      "columns": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "columnName": "回應字串",
          "columnType": "回應字串",
          "description": "回應字串",
          "isPrimaryKey": false,
          "isNullable": false,
          "createdAt": "回應字串",
          "updatedAt": "回應字串"
        }
      ],
      "createdAt": "回應字串",
      "updatedAt": "回應字串"
    }
  ],
  "chatbots": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "回應字串"
    }
  ],
  "groups": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "回應字串"
    }
  ],
  "createdBy": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "回應字串"
  },
  "canUpdate": false,
  "canDelete": false,
  "createdAt": "回應字串",
  "updatedAt": "回應字串"
}

---

刪除 SQL 資料庫

DELETE /api/v1/sql-databases/{id}/

參數

參數名稱	必填	類型	說明
id	✅	string	A UUID string identifying this SQL Database.

程式碼範例

Shell/Bash

# 呼叫 API 示例 (Shell)
curl -X DELETE "https://api.maiagent.ai/api/v1/sql-databases/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。

JavaScript

Python

PHP

回應內容

狀態碼	說明
204	No response body

---

測試資料庫連線

POST /api/v1/sql-databases/{id}/test-connection/

參數

參數名稱	必填	類型	說明
id	✅	string	A UUID string identifying this SQL Database.

請求內容

請求參數

欄位	類型	必填	說明
databaseType	string (enum: postgresql, mysql, maiagent, oracle, mssql)	是	postgresql: PostgreSQL ; mysql: MySQL ; maiagent: MaiAgent ; oracle: Oracle ; mssql: MSSQL;
databaseUrl	string	是

請求結構範例

{
  "databaseType": string (enum: postgresql, mysql, maiagent, oracle, mssql) // * `postgresql` - PostgreSQL
* `mysql` - MySQL
* `maiagent` - MaiAgent
* `oracle` - Oracle
* `mssql` - MSSQL
  "databaseUrl": string
}

請求範例值

{
  "databaseType": "postgresql",
  "databaseUrl": "範例字串"
}

程式碼範例

Shell/Bash

# 呼叫 API 示例 (Shell)
curl -X POST "https://api.maiagent.ai/api/v1/sql-databases/550e8400-e29b-41d4-a716-446655440000/test-connection/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "databaseType": "postgresql",
    "databaseUrl": "範例字串"
  }'

# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。

JavaScript

Python

PHP

回應內容

狀態碼: 200

回應結構範例

{
  "success"?: boolean // 非必填
  "message"?: string // 非必填
}

回應範例值

{
  "success": false,
  "message": "回應字串"
}

---

上傳檔案至資料庫

POST /api/v1/sql-databases/{id}/upload-files/

參數

參數名稱	必填	類型	說明
id	✅	string	A UUID string identifying this SQL Database.

請求內容

請求參數

欄位	類型	必填	說明
files	array[object]	是

請求結構範例

{
  "files": [
    {
      "file": string // File path from presigned URL upload (e.g., media/chatbotfiles/xxx/file.csv)
      "filename": string // Original filename
      "size": integer // File size in bytes
    }
  ]
}

請求範例值

{
  "files": [
    {
      "file": "media/chatbotfiles/xxx/data.csv",
      "filename": "data.csv",
      "size": 1024
    },
    {
      "file": "media/chatbotfiles/xxx/report.xlsx",
      "filename": "report.xlsx",
      "size": 2048
    }
  ]
}

程式碼範例

Shell/Bash

# 呼叫 API 示例 (Shell)
curl -X POST "https://api.maiagent.ai/api/v1/sql-databases/550e8400-e29b-41d4-a716-446655440000/upload-files/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "files": [
      {
        "file": "media/chatbotfiles/xxx/data.csv",
        "filename": "data.csv",
        "size": 1024
      },
      {
        "file": "media/chatbotfiles/xxx/report.xlsx",
        "filename": "report.xlsx",
        "size": 2048
      }
    ]
  }'

# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。

JavaScript

Python

PHP

回應內容

狀態碼: 201

回應結構範例

{
  "message"?: string // 非必填
  "filesCount"?: integer // 非必填
  "fileIds"?: [ // 非必填
    string (uuid)
  ]
}

回應範例值

{
  "message": "回應字串",
  "filesCount": 456,
  "fileIds": [
    "550e8400-e29b-41d4-a716-446655440000"
  ]
}

---

批量刪除 SQL 資料庫

POST /api/v1/sql-databases/batch-delete/

請求內容

請求參數

欄位	類型	必填	說明
ids	array[string]	是

請求結構範例

{
  "ids": [
    string (uuid)
  ]
}

請求範例值

{
  "ids": [
    "550e8400-e29b-41d4-a716-446655440000"
  ]
}

程式碼範例

Shell/Bash

# 呼叫 API 示例 (Shell)
curl -X POST "https://api.maiagent.ai/api/v1/sql-databases/batch-delete/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": [
      "550e8400-e29b-41d4-a716-446655440000"
    ]
  }'

# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。

JavaScript

Python

PHP

回應內容

狀態碼	說明
204	No response body

---

列出資料表

GET /api/v1/sql-databases/{sqlDatabasePk}/tables/

參數

參數名稱	必填	類型	說明
sqlDatabasePk	✅	string
page	❌	integer	A page number within the paginated result set.
pageSize	❌	integer	Number of results to return per page.
query	❌	string
status	❌	string	`pending`: Pending ; `processing`: Processing ; `success`: Success ; `failed`: Failed ; `dropping`: Dropping ; `drop_failed`: Drop Failed;

程式碼範例

Shell/Bash

# 呼叫 API 示例 (Shell)
curl -X GET "https://api.maiagent.ai/api/v1/sql-databases/{sqlDatabasePk}/tables/?page=1&pageSize=1&query=example&status=drop_failed" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。

JavaScript

Python

PHP

回應內容

狀態碼: 200

回應結構範例

{
  "count": integer
  "next"?: string (uri) // 非必填
  "previous"?: string (uri) // 非必填
  "results": [
    {
      "id": string (uuid)
      "tableName": string // Name of the table in the database
      "description"?: string // Description of the table and its data for better Text-to-SQL understanding (非必填)
      "status": 
      {
      }
      "errorMessage": string // Error details if table creation or deletion failed
      "sourceFile": 
      {
        "id": string (uuid)
        "name": string
        "isFromKnowledgeBase": boolean // Determine if the source file originated from a knowledge base upload.

Returns True if the file was uploaded via knowledge base,
False if uploaded directly to the database.
      }
      "columns": [
        {
          "id": string (uuid)
          "columnName": string
          "columnType"?: string // Data type of the column (e.g., VARCHAR, INTEGER, TIMESTAMP) (非必填)
          "description"?: string // Description of the column for better Text-to-SQL understanding (非必填)
          "isPrimaryKey"?: boolean // 非必填
          "isNullable"?: boolean // 非必填
          "createdAt": string (timestamp)
          "updatedAt": string (timestamp)
        }
      ]
      "createdAt": string (timestamp)
      "updatedAt": string (timestamp)
    }
  ]
}

回應範例值

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "tableName": "回應字串",
      "description": "回應字串",
      "status": {},
      "errorMessage": "回應字串",
      "sourceFile": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "回應字串",
        "isFromKnowledgeBase": false
      },
      "columns": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "columnName": "回應字串",
          "columnType": "回應字串",
          "description": "回應字串",
          "isPrimaryKey": false,
          "isNullable": false,
          "createdAt": "回應字串",
          "updatedAt": "回應字串"
        }
      ],
      "createdAt": "回應字串",
      "updatedAt": "回應字串"
    }
  ]
}

---

建立資料表

POST /api/v1/sql-databases/{sqlDatabasePk}/tables/

參數

參數名稱	必填	類型	說明
sqlDatabasePk	✅	string

請求內容

請求參數

欄位	類型	必填	說明
tableName	string	是	Name of the table in the database
description	string	否	Description of the table and its data for better Text-to-SQL understanding

請求結構範例

{
  "tableName": string // Name of the table in the database
  "description"?: string // Description of the table and its data for better Text-to-SQL understanding (非必填)
}

請求範例值

{
  "tableName": "範例字串",
  "description": "範例字串"
}

程式碼範例

Shell/Bash

# 呼叫 API 示例 (Shell)
curl -X POST "https://api.maiagent.ai/api/v1/sql-databases/{sqlDatabasePk}/tables/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tableName": "範例字串",
    "description": "範例字串"
  }'

# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。

JavaScript

Python

PHP

回應內容

狀態碼: 201

回應結構範例

{
  "id": string (uuid)
  "tableName": string // Name of the table in the database
  "description"?: string // Description of the table and its data for better Text-to-SQL understanding (非必填)
  "status": 
  {
  }
  "errorMessage": string // Error details if table creation or deletion failed
  "sourceFile": 
  {
    "id": string (uuid)
    "name": string
    "isFromKnowledgeBase": boolean // Determine if the source file originated from a knowledge base upload.

Returns True if the file was uploaded via knowledge base,
False if uploaded directly to the database.
  }
  "columns": [
    {
      "id": string (uuid)
      "columnName": string
      "columnType"?: string // Data type of the column (e.g., VARCHAR, INTEGER, TIMESTAMP) (非必填)
      "description"?: string // Description of the column for better Text-to-SQL understanding (非必填)
      "isPrimaryKey"?: boolean // 非必填
      "isNullable"?: boolean // 非必填
      "createdAt": string (timestamp)
      "updatedAt": string (timestamp)
    }
  ]
  "createdAt": string (timestamp)
  "updatedAt": string (timestamp)
}

回應範例值

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "tableName": "回應字串",
  "description": "回應字串",
  "status": {},
  "errorMessage": "回應字串",
  "sourceFile": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "回應字串",
    "isFromKnowledgeBase": false
  },
  "columns": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "columnName": "回應字串",
      "columnType": "回應字串",
      "description": "回應字串",
      "isPrimaryKey": false,
      "isNullable": false,
      "createdAt": "回應字串",
      "updatedAt": "回應字串"
    }
  ],
  "createdAt": "回應字串",
  "updatedAt": "回應字串"
}

---

取得特定資料表

GET /api/v1/sql-databases/{sqlDatabasePk}/tables/{id}/

參數

參數名稱	必填	類型	說明
id	✅	string	A UUID string identifying this Database Table.
sqlDatabasePk	✅	string

程式碼範例

Shell/Bash

# 呼叫 API 示例 (Shell)
curl -X GET "https://api.maiagent.ai/api/v1/sql-databases/{sqlDatabasePk}/tables/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。

JavaScript

Python

PHP

回應內容

狀態碼: 200

回應結構範例

{
  "id": string (uuid)
  "tableName": string // Name of the table in the database
  "description"?: string // Description of the table and its data for better Text-to-SQL understanding (非必填)
  "status": 
  {
  }
  "errorMessage": string // Error details if table creation or deletion failed
  "sourceFile": 
  {
    "id": string (uuid)
    "name": string
    "isFromKnowledgeBase": boolean // Determine if the source file originated from a knowledge base upload.

Returns True if the file was uploaded via knowledge base,
False if uploaded directly to the database.
  }
  "columns": [
    {
      "id": string (uuid)
      "columnName": string
      "columnType"?: string // Data type of the column (e.g., VARCHAR, INTEGER, TIMESTAMP) (非必填)
      "description"?: string // Description of the column for better Text-to-SQL understanding (非必填)
      "isPrimaryKey"?: boolean // 非必填
      "isNullable"?: boolean // 非必填
      "createdAt": string (timestamp)
      "updatedAt": string (timestamp)
    }
  ]
  "createdAt": string (timestamp)
  "updatedAt": string (timestamp)
}

回應範例值

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "tableName": "回應字串",
  "description": "回應字串",
  "status": {},
  "errorMessage": "回應字串",
  "sourceFile": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "回應字串",
    "isFromKnowledgeBase": false
  },
  "columns": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "columnName": "回應字串",
      "columnType": "回應字串",
      "description": "回應字串",
      "isPrimaryKey": false,
      "isNullable": false,
      "createdAt": "回應字串",
      "updatedAt": "回應字串"
    }
  ],
  "createdAt": "回應字串",
  "updatedAt": "回應字串"
}

---

更新資料表

PUT /api/v1/sql-databases/{sqlDatabasePk}/tables/{id}/

參數

參數名稱	必填	類型	說明
id	✅	string	A UUID string identifying this Database Table.
sqlDatabasePk	✅	string

請求內容

請求參數

欄位	類型	必填	說明
tableName	string	是	Name of the table in the database
description	string	否	Description of the table and its data for better Text-to-SQL understanding

請求結構範例

{
  "tableName": string // Name of the table in the database
  "description"?: string // Description of the table and its data for better Text-to-SQL understanding (非必填)
}

請求範例值

{
  "tableName": "範例字串",
  "description": "範例字串"
}

程式碼範例

Shell/Bash

# 呼叫 API 示例 (Shell)
curl -X PUT "https://api.maiagent.ai/api/v1/sql-databases/{sqlDatabasePk}/tables/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tableName": "範例字串",
    "description": "範例字串"
  }'

# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。

JavaScript

Python

PHP

回應內容

狀態碼: 200

回應結構範例

{
  "id": string (uuid)
  "tableName": string // Name of the table in the database
  "description"?: string // Description of the table and its data for better Text-to-SQL understanding (非必填)
  "status": 
  {
  }
  "errorMessage": string // Error details if table creation or deletion failed
  "sourceFile": 
  {
    "id": string (uuid)
    "name": string
    "isFromKnowledgeBase": boolean // Determine if the source file originated from a knowledge base upload.

Returns True if the file was uploaded via knowledge base,
False if uploaded directly to the database.
  }
  "columns": [
    {
      "id": string (uuid)
      "columnName": string
      "columnType"?: string // Data type of the column (e.g., VARCHAR, INTEGER, TIMESTAMP) (非必填)
      "description"?: string // Description of the column for better Text-to-SQL understanding (非必填)
      "isPrimaryKey"?: boolean // 非必填
      "isNullable"?: boolean // 非必填
      "createdAt": string (timestamp)
      "updatedAt": string (timestamp)
    }
  ]
  "createdAt": string (timestamp)
  "updatedAt": string (timestamp)
}

回應範例值

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "tableName": "回應字串",
  "description": "回應字串",
  "status": {},
  "errorMessage": "回應字串",
  "sourceFile": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "回應字串",
    "isFromKnowledgeBase": false
  },
  "columns": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "columnName": "回應字串",
      "columnType": "回應字串",
      "description": "回應字串",
      "isPrimaryKey": false,
      "isNullable": false,
      "createdAt": "回應字串",
      "updatedAt": "回應字串"
    }
  ],
  "createdAt": "回應字串",
  "updatedAt": "回應字串"
}

---

部分更新資料表

PATCH /api/v1/sql-databases/{sqlDatabasePk}/tables/{id}/

參數

參數名稱	必填	類型	說明
id	✅	string	A UUID string identifying this Database Table.
sqlDatabasePk	✅	string

請求內容

請求參數

欄位	類型	必填	說明
tableName	string	否	Name of the table in the database
description	string	否	Description of the table and its data for better Text-to-SQL understanding

請求結構範例

{
  "tableName"?: string // Name of the table in the database (非必填)
  "description"?: string // Description of the table and its data for better Text-to-SQL understanding (非必填)
}

請求範例值

{
  "tableName": "範例字串",
  "description": "範例字串"
}

程式碼範例

Shell/Bash

# 呼叫 API 示例 (Shell)
curl -X PATCH "https://api.maiagent.ai/api/v1/sql-databases/{sqlDatabasePk}/tables/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tableName": "範例字串",
    "description": "範例字串"
  }'

# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。

JavaScript

Python

PHP

回應內容

狀態碼: 200

回應結構範例

{
  "id": string (uuid)
  "tableName": string // Name of the table in the database
  "description"?: string // Description of the table and its data for better Text-to-SQL understanding (非必填)
  "status": 
  {
  }
  "errorMessage": string // Error details if table creation or deletion failed
  "sourceFile": 
  {
    "id": string (uuid)
    "name": string
    "isFromKnowledgeBase": boolean // Determine if the source file originated from a knowledge base upload.

Returns True if the file was uploaded via knowledge base,
False if uploaded directly to the database.
  }
  "columns": [
    {
      "id": string (uuid)
      "columnName": string
      "columnType"?: string // Data type of the column (e.g., VARCHAR, INTEGER, TIMESTAMP) (非必填)
      "description"?: string // Description of the column for better Text-to-SQL understanding (非必填)
      "isPrimaryKey"?: boolean // 非必填
      "isNullable"?: boolean // 非必填
      "createdAt": string (timestamp)
      "updatedAt": string (timestamp)
    }
  ]
  "createdAt": string (timestamp)
  "updatedAt": string (timestamp)
}

回應範例值

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "tableName": "回應字串",
  "description": "回應字串",
  "status": {},
  "errorMessage": "回應字串",
  "sourceFile": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "回應字串",
    "isFromKnowledgeBase": false
  },
  "columns": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "columnName": "回應字串",
      "columnType": "回應字串",
      "description": "回應字串",
      "isPrimaryKey": false,
      "isNullable": false,
      "createdAt": "回應字串",
      "updatedAt": "回應字串"
    }
  ],
  "createdAt": "回應字串",
  "updatedAt": "回應字串"
}

---

刪除資料表

DELETE /api/v1/sql-databases/{sqlDatabasePk}/tables/{id}/

參數

參數名稱	必填	類型	說明
id	✅	string	A UUID string identifying this Database Table.
sqlDatabasePk	✅	string

程式碼範例

Shell/Bash

# 呼叫 API 示例 (Shell)
curl -X DELETE "https://api.maiagent.ai/api/v1/sql-databases/{sqlDatabasePk}/tables/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。

JavaScript

Python

PHP

回應內容

狀態碼	說明
204	No response body

---

批量刪除資料表

POST /api/v1/sql-databases/{sqlDatabasePk}/tables/batch-delete/

參數

參數名稱	必填	類型	說明
sqlDatabasePk	✅	string

請求內容

請求參數

欄位	類型	必填	說明
ids	array[string]	是

請求結構範例

{
  "ids": [
    string (uuid)
  ]
}

請求範例值

{
  "ids": [
    "550e8400-e29b-41d4-a716-446655440000"
  ]
}

程式碼範例

Shell/Bash

# 呼叫 API 示例 (Shell)
curl -X POST "https://api.maiagent.ai/api/v1/sql-databases/{sqlDatabasePk}/tables/batch-delete/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": [
      "550e8400-e29b-41d4-a716-446655440000"
    ]
  }'

# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。

JavaScript

Python

PHP

回應內容

狀態碼	說明
204	No response body

---

列出資料欄位

GET /api/v1/sql-databases/{sqlDatabasePk}/tables/{tablePk}/columns/

參數

參數名稱	必填	類型	說明
sqlDatabasePk	✅	string
tablePk	✅	string

程式碼範例

Shell/Bash

# 呼叫 API 示例 (Shell)
curl -X GET "https://api.maiagent.ai/api/v1/sql-databases/{sqlDatabasePk}/tables/{tablePk}/columns/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。

JavaScript

Python

PHP

回應內容

狀態碼: 200

回應結構範例

[
  {
    "id": string (uuid)
    "columnName": string
    "columnType"?: string // Data type of the column (e.g., VARCHAR, INTEGER, TIMESTAMP) (非必填)
    "description"?: string // Description of the column for better Text-to-SQL understanding (非必填)
    "isPrimaryKey"?: boolean // 非必填
    "isNullable"?: boolean // 非必填
    "createdAt": string (timestamp)
    "updatedAt": string (timestamp)
  }
]

回應範例值

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "columnName": "回應字串",
    "columnType": "回應字串",
    "description": "回應字串",
    "isPrimaryKey": false,
    "isNullable": false,
    "createdAt": "回應字串",
    "updatedAt": "回應字串"
  }
]

---

取得特定資料欄位

GET /api/v1/sql-databases/{sqlDatabasePk}/tables/{tablePk}/columns/{id}/

參數

參數名稱	必填	類型	說明
id	✅	string	A UUID string identifying this Database Table Column.
sqlDatabasePk	✅	string
tablePk	✅	string

程式碼範例

Shell/Bash

# 呼叫 API 示例 (Shell)
curl -X GET "https://api.maiagent.ai/api/v1/sql-databases/{sqlDatabasePk}/tables/{tablePk}/columns/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。

JavaScript

Python

PHP

回應內容

狀態碼: 200

回應結構範例

{
  "id": string (uuid)
  "columnName": string
  "columnType"?: string // Data type of the column (e.g., VARCHAR, INTEGER, TIMESTAMP) (非必填)
  "description"?: string // Description of the column for better Text-to-SQL understanding (非必填)
  "isPrimaryKey"?: boolean // 非必填
  "isNullable"?: boolean // 非必填
  "createdAt": string (timestamp)
  "updatedAt": string (timestamp)
}

回應範例值

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "columnName": "回應字串",
  "columnType": "回應字串",
  "description": "回應字串",
  "isPrimaryKey": false,
  "isNullable": false,
  "createdAt": "回應字串",
  "updatedAt": "回應字串"
}

---

更新資料欄位

PUT /api/v1/sql-databases/{sqlDatabasePk}/tables/{tablePk}/columns/{id}/

參數

參數名稱	必填	類型	說明
id	✅	string	A UUID string identifying this Database Table Column.
sqlDatabasePk	✅	string
tablePk	✅	string

請求內容

請求參數

欄位	類型	必填	說明
columnName	string	是
columnType	string	否	Data type of the column (e.g., VARCHAR, INTEGER, TIMESTAMP)
description	string	否	Description of the column for better Text-to-SQL understanding
isPrimaryKey	boolean	否
isNullable	boolean	否

請求結構範例

{
  "columnName": string
  "columnType"?: string // Data type of the column (e.g., VARCHAR, INTEGER, TIMESTAMP) (非必填)
  "description"?: string // Description of the column for better Text-to-SQL understanding (非必填)
  "isPrimaryKey"?: boolean // 非必填
  "isNullable"?: boolean // 非必填
}

請求範例值

{
  "columnName": "範例字串",
  "columnType": "範例字串",
  "description": "範例字串",
  "isPrimaryKey": true,
  "isNullable": true
}

程式碼範例

Shell/Bash

# 呼叫 API 示例 (Shell)
curl -X PUT "https://api.maiagent.ai/api/v1/sql-databases/{sqlDatabasePk}/tables/{tablePk}/columns/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "columnName": "範例字串",
    "columnType": "範例字串",
    "description": "範例字串",
    "isPrimaryKey": true,
    "isNullable": true
  }'

# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。

JavaScript

Python

PHP

回應內容

狀態碼: 200

回應結構範例

{
  "id": string (uuid)
  "columnName": string
  "columnType"?: string // Data type of the column (e.g., VARCHAR, INTEGER, TIMESTAMP) (非必填)
  "description"?: string // Description of the column for better Text-to-SQL understanding (非必填)
  "isPrimaryKey"?: boolean // 非必填
  "isNullable"?: boolean // 非必填
  "createdAt": string (timestamp)
  "updatedAt": string (timestamp)
}

回應範例值

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "columnName": "回應字串",
  "columnType": "回應字串",
  "description": "回應字串",
  "isPrimaryKey": false,
  "isNullable": false,
  "createdAt": "回應字串",
  "updatedAt": "回應字串"
}

---

部分更新資料欄位

PATCH /api/v1/sql-databases/{sqlDatabasePk}/tables/{tablePk}/columns/{id}/

參數

參數名稱	必填	類型	說明
id	✅	string	A UUID string identifying this Database Table Column.
sqlDatabasePk	✅	string
tablePk	✅	string

請求內容

請求參數

欄位	類型	必填	說明
columnName	string	否
columnType	string	否	Data type of the column (e.g., VARCHAR, INTEGER, TIMESTAMP)
description	string	否	Description of the column for better Text-to-SQL understanding
isPrimaryKey	boolean	否
isNullable	boolean	否

請求結構範例

{
  "columnName"?: string // 非必填
  "columnType"?: string // Data type of the column (e.g., VARCHAR, INTEGER, TIMESTAMP) (非必填)
  "description"?: string // Description of the column for better Text-to-SQL understanding (非必填)
  "isPrimaryKey"?: boolean // 非必填
  "isNullable"?: boolean // 非必填
}

請求範例值

{
  "columnName": "範例字串",
  "columnType": "範例字串",
  "description": "範例字串",
  "isPrimaryKey": true,
  "isNullable": true
}

程式碼範例

Shell/Bash

# 呼叫 API 示例 (Shell)
curl -X PATCH "https://api.maiagent.ai/api/v1/sql-databases/{sqlDatabasePk}/tables/{tablePk}/columns/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "columnName": "範例字串",
    "columnType": "範例字串",
    "description": "範例字串",
    "isPrimaryKey": true,
    "isNullable": true
  }'

# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。

JavaScript

Python

PHP

回應內容

狀態碼: 200

回應結構範例

{
  "id": string (uuid)
  "columnName": string
  "columnType"?: string // Data type of the column (e.g., VARCHAR, INTEGER, TIMESTAMP) (非必填)
  "description"?: string // Description of the column for better Text-to-SQL understanding (非必填)
  "isPrimaryKey"?: boolean // 非必填
  "isNullable"?: boolean // 非必填
  "createdAt": string (timestamp)
  "updatedAt": string (timestamp)
}

回應範例值

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "columnName": "回應字串",
  "columnType": "回應字串",
  "description": "回應字串",
  "isPrimaryKey": false,
  "isNullable": false,
  "createdAt": "回應字串",
  "updatedAt": "回應字串"
}

---

測試資料庫連線（通用）

POST /api/v1/database-connection/test/

請求內容

請求參數

欄位	類型	必填	說明
databaseType	object	是	資料庫類型（不包含 MaiAgent 內部使用類型） postgresql: PostgreSQL ; mysql: MySQL ; oracle: Oracle ; mssql: MSSQL;
databaseUrl	string	是	資料庫連線字串

請求結構範例

{
  "databaseType":  // 資料庫類型（不包含 MaiAgent 內部使用類型）

* `postgresql` - PostgreSQL
* `mysql` - MySQL
* `oracle` - Oracle
* `mssql` - MSSQL
  {
  }
  "databaseUrl": string // 資料庫連線字串
}

請求範例值

{
  "database_type": "postgresql",
  "database_url": "postgresql://user:password@localhost:5432/dbname"
}

程式碼範例

Shell/Bash

# 呼叫 API 示例 (Shell)
curl -X POST "https://api.maiagent.ai/api/v1/database-connection/test/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "database_type": "postgresql",
    "database_url": "postgresql://user:password@localhost:5432/dbname"
  }'

# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。

JavaScript

Python

PHP

回應內容

狀態碼: 200

回應結構範例

{
  "status":  // 連線狀態

* `success` - success
* `failed` - failed
  {
  }
  "responseTime"?: number (double) // 回應時間（秒） (非必填)
  "message"?: string // 成功訊息 (非必填)
  "errorMessage"?: string // 錯誤訊息 (非必填)
}

回應範例值

{
  "status": "success",
  "response_time": 0.123,
  "message": "成功連接到 PostgreSQL 資料庫"
}

狀態碼: 400

回應結構範例

{
  "detail"?: string // 非必填
}

回應範例值

{
  "status": "success",
  "response_time": 0.123,
  "message": "成功連接到 PostgreSQL 資料庫"
}

---

列出資料庫連線字串範例

GET /api/v1/database-examples/

程式碼範例

Shell/Bash

# 呼叫 API 示例 (Shell)
curl -X GET "https://api.maiagent.ai/api/v1/database-examples/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。

JavaScript

Python

PHP

回應內容

狀態碼: 200

回應結構範例

[
  {
    "databaseType"?:  // 資料庫類型選項

* `postgresql` - PostgreSQL
* `mysql` - MySQL
* `maiagent` - MaiAgent
* `oracle` - Oracle
* `mssql` - MSSQL (非必填)
    {
    }
    "databaseTypeExample": string // 例如：postgresql://db_user:db_password@db_ip:db_port/db_name
  }
]

回應範例值

[
  {
    "databaseType": {},
    "databaseTypeExample": "回應字串"
  }
]

狀態碼: 401

回應結構範例

{
  "detail"?: string // 非必填
}

回應範例值

{
  "detail": "回應字串"
}

---

取得特定連線字串範例

GET /api/v1/database-examples/{id}/

參數

參數名稱	必填	類型	說明
id	✅	string	A UUID string identifying this 資料庫連線範例.

程式碼範例

Shell/Bash

# 呼叫 API 示例 (Shell)
curl -X GET "https://api.maiagent.ai/api/v1/database-examples/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。

JavaScript

Python

PHP

回應內容

狀態碼: 200

回應結構範例

{
  "databaseType"?:  // 資料庫類型選項

* `postgresql` - PostgreSQL
* `mysql` - MySQL
* `maiagent` - MaiAgent
* `oracle` - Oracle
* `mssql` - MSSQL (非必填)
  {
  }
  "databaseTypeExample": string // 例如：postgresql://db_user:db_password@db_ip:db_port/db_name
}

回應範例值

{
  "databaseType": {},
  "databaseTypeExample": "回應字串"
}

---

列出 AI 助理的資料庫配置

GET /api/v1/chatbots/{chatbotPk}/databases/

參數

參數名稱	必填	類型	說明
chatbotPk	✅	string	A UUID string identifying this Chatbot ID
page	❌	integer	A page number within the paginated result set.
pageSize	❌	integer	Number of results to return per page.

程式碼範例

Shell/Bash

# 呼叫 API 示例 (Shell)
curl -X GET "https://api.maiagent.ai/api/v1/chatbots/550e8400-e29b-41d4-a716-446655440000/databases/?page=1&pageSize=1" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。

JavaScript

Python

PHP

回應內容

狀態碼: 200

回應結構範例

{
  "count": integer
  "next"?: string (uri) // 非必填
  "previous"?: string (uri) // 非必填
  "results": [
    {
      "id": string (uuid)
      "name": string // 顯示用的名稱，例如：主要業務DB、分析DB
      "databaseType":  // 資料庫類型選項，有 MySQL、PostgreSQL、MSSQL、Oracle、MaiAgent

* `postgresql` - PostgreSQL
* `mysql` - MySQL
* `maiagent` - MaiAgent
* `oracle` - Oracle
* `mssql` - MSSQL
      {
      }
      "databaseUrl": string // 資料庫連線字串
      "includeTables"?: object // 指定要查詢的資料表列表，格式: {"tables": ["table1", "table2"]}。MaiAgent 類型會自動從上傳的檔案中取得，不需要手動設定 (非必填)
      "isActive"?: boolean // 停用後將不會在 Text-to-SQL 查詢中使用此資料庫 (非必填)
      "createdAt": string (timestamp)
      "updatedAt": string (timestamp)
    }
  ]
}

回應範例值

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "回應字串",
      "databaseType": {},
      "databaseUrl": "回應字串",
      "includeTables": null,
      "isActive": false,
      "createdAt": "回應字串",
      "updatedAt": "回應字串"
    }
  ]
}

---

新增 AI 助理的資料庫配置

POST /api/v1/chatbots/{chatbotPk}/databases/

參數

參數名稱	必填	類型	說明
chatbotPk	✅	string	A UUID string identifying this Chatbot ID

請求內容

請求參數

欄位	類型	必填	說明
name	string	是	顯示用的名稱，例如：主要業務DB、分析DB
databaseType	object	是	資料庫類型選項，有 MySQL、PostgreSQL、MSSQL、Oracle、MaiAgent postgresql: PostgreSQL ; mysql: MySQL ; maiagent: MaiAgent ; oracle: Oracle ; mssql: MSSQL;
databaseUrl	string	是	資料庫連線字串
includeTables	object	否	指定要查詢的資料表列表，格式: {"tables": ["table1", "table2"]}。MaiAgent 類型會自動從上傳的檔案中取得，不需要手動設定
isActive	boolean	否	停用後將不會在 Text-to-SQL 查詢中使用此資料庫

請求結構範例

{
  "name": string // 顯示用的名稱，例如：主要業務DB、分析DB
  "databaseType":  // 資料庫類型選項，有 MySQL、PostgreSQL、MSSQL、Oracle、MaiAgent

* `postgresql` - PostgreSQL
* `mysql` - MySQL
* `maiagent` - MaiAgent
* `oracle` - Oracle
* `mssql` - MSSQL
  {
  }
  "databaseUrl": string // 資料庫連線字串
  "includeTables"?: object // 指定要查詢的資料表列表，格式: {"tables": ["table1", "table2"]}。MaiAgent 類型會自動從上傳的檔案中取得，不需要手動設定 (非必填)
  "isActive"?: boolean // 停用後將不會在 Text-to-SQL 查詢中使用此資料庫 (非必填)
}

請求範例值

{
  "name": "範例名稱",
  "databaseType": {},
  "databaseUrl": "範例字串",
  "includeTables": null,
  "isActive": true
}

程式碼範例

Shell/Bash

# 呼叫 API 示例 (Shell)
curl -X POST "https://api.maiagent.ai/api/v1/chatbots/550e8400-e29b-41d4-a716-446655440000/databases/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "範例名稱",
    "databaseType": {},
    "databaseUrl": "範例字串",
    "includeTables": null,
    "isActive": true
  }'

# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。

JavaScript

Python

PHP

回應內容

狀態碼: 201

回應結構範例

{
  "id": string (uuid)
  "name": string // 顯示用的名稱，例如：主要業務DB、分析DB
  "databaseType":  // 資料庫類型選項，有 MySQL、PostgreSQL、MSSQL、Oracle、MaiAgent

* `postgresql` - PostgreSQL
* `mysql` - MySQL
* `maiagent` - MaiAgent
* `oracle` - Oracle
* `mssql` - MSSQL
  {
  }
  "databaseUrl": string // 資料庫連線字串
  "includeTables"?: object // 指定要查詢的資料表列表，格式: {"tables": ["table1", "table2"]}。MaiAgent 類型會自動從上傳的檔案中取得，不需要手動設定 (非必填)
  "isActive"?: boolean // 停用後將不會在 Text-to-SQL 查詢中使用此資料庫 (非必填)
  "createdAt": string (timestamp)
  "updatedAt": string (timestamp)
}

回應範例值

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "回應字串",
  "databaseType": {},
  "databaseUrl": "回應字串",
  "includeTables": null,
  "isActive": false,
  "createdAt": "回應字串",
  "updatedAt": "回應字串"
}

---

取得特定資料庫配置

GET /api/v1/chatbots/{chatbotPk}/databases/{id}/

參數

參數名稱	必填	類型	說明
chatbotPk	✅	string	A UUID string identifying this Chatbot ID
id	✅	string	A UUID string identifying this Chatbot 資料庫配置.

程式碼範例

Shell/Bash

# 呼叫 API 示例 (Shell)
curl -X GET "https://api.maiagent.ai/api/v1/chatbots/550e8400-e29b-41d4-a716-446655440000/databases/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。

JavaScript

Python

PHP

回應內容

狀態碼: 200

回應結構範例

{
  "id": string (uuid)
  "name": string // 顯示用的名稱，例如：主要業務DB、分析DB
  "databaseType":  // 資料庫類型選項，有 MySQL、PostgreSQL、MSSQL、Oracle、MaiAgent

* `postgresql` - PostgreSQL
* `mysql` - MySQL
* `maiagent` - MaiAgent
* `oracle` - Oracle
* `mssql` - MSSQL
  {
  }
  "databaseUrl": string // 資料庫連線字串
  "includeTables"?: object // 指定要查詢的資料表列表，格式: {"tables": ["table1", "table2"]}。MaiAgent 類型會自動從上傳的檔案中取得，不需要手動設定 (非必填)
  "isActive"?: boolean // 停用後將不會在 Text-to-SQL 查詢中使用此資料庫 (非必填)
  "createdAt": string (timestamp)
  "updatedAt": string (timestamp)
}

回應範例值

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "回應字串",
  "databaseType": {},
  "databaseUrl": "回應字串",
  "includeTables": null,
  "isActive": false,
  "createdAt": "回應字串",
  "updatedAt": "回應字串"
}

---

更新資料庫配置

PUT /api/v1/chatbots/{chatbotPk}/databases/{id}/

參數

參數名稱	必填	類型	說明
chatbotPk	✅	string	A UUID string identifying this Chatbot ID
id	✅	string	A UUID string identifying this Chatbot 資料庫配置.

請求內容

請求參數

欄位	類型	必填	說明
name	string	是	顯示用的名稱，例如：主要業務DB、分析DB
databaseType	object	是	資料庫類型選項，有 MySQL、PostgreSQL、MSSQL、Oracle、MaiAgent postgresql: PostgreSQL ; mysql: MySQL ; maiagent: MaiAgent ; oracle: Oracle ; mssql: MSSQL;
databaseUrl	string	是	資料庫連線字串
includeTables	object	否	指定要查詢的資料表列表，格式: {"tables": ["table1", "table2"]}。MaiAgent 類型會自動從上傳的檔案中取得，不需要手動設定
isActive	boolean	否	停用後將不會在 Text-to-SQL 查詢中使用此資料庫

請求結構範例

{
  "name": string // 顯示用的名稱，例如：主要業務DB、分析DB
  "databaseType":  // 資料庫類型選項，有 MySQL、PostgreSQL、MSSQL、Oracle、MaiAgent

* `postgresql` - PostgreSQL
* `mysql` - MySQL
* `maiagent` - MaiAgent
* `oracle` - Oracle
* `mssql` - MSSQL
  {
  }
  "databaseUrl": string // 資料庫連線字串
  "includeTables"?: object // 指定要查詢的資料表列表，格式: {"tables": ["table1", "table2"]}。MaiAgent 類型會自動從上傳的檔案中取得，不需要手動設定 (非必填)
  "isActive"?: boolean // 停用後將不會在 Text-to-SQL 查詢中使用此資料庫 (非必填)
}

請求範例值

{
  "name": "範例名稱",
  "databaseType": {},
  "databaseUrl": "範例字串",
  "includeTables": null,
  "isActive": true
}

程式碼範例

Shell/Bash

# 呼叫 API 示例 (Shell)
curl -X PUT "https://api.maiagent.ai/api/v1/chatbots/550e8400-e29b-41d4-a716-446655440000/databases/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "範例名稱",
    "databaseType": {},
    "databaseUrl": "範例字串",
    "includeTables": null,
    "isActive": true
  }'

# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。

JavaScript

Python

PHP

回應內容

狀態碼: 200

回應結構範例

{
  "id": string (uuid)
  "name": string // 顯示用的名稱，例如：主要業務DB、分析DB
  "databaseType":  // 資料庫類型選項，有 MySQL、PostgreSQL、MSSQL、Oracle、MaiAgent

* `postgresql` - PostgreSQL
* `mysql` - MySQL
* `maiagent` - MaiAgent
* `oracle` - Oracle
* `mssql` - MSSQL
  {
  }
  "databaseUrl": string // 資料庫連線字串
  "includeTables"?: object // 指定要查詢的資料表列表，格式: {"tables": ["table1", "table2"]}。MaiAgent 類型會自動從上傳的檔案中取得，不需要手動設定 (非必填)
  "isActive"?: boolean // 停用後將不會在 Text-to-SQL 查詢中使用此資料庫 (非必填)
  "createdAt": string (timestamp)
  "updatedAt": string (timestamp)
}

回應範例值

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "回應字串",
  "databaseType": {},
  "databaseUrl": "回應字串",
  "includeTables": null,
  "isActive": false,
  "createdAt": "回應字串",
  "updatedAt": "回應字串"
}

---

部分更新資料庫配置

PATCH /api/v1/chatbots/{chatbotPk}/databases/{id}/

參數

參數名稱	必填	類型	說明
chatbotPk	✅	string	A UUID string identifying this Chatbot ID
id	✅	string	A UUID string identifying this Chatbot 資料庫配置.

請求內容

請求參數

欄位	類型	必填	說明
name	string	否	顯示用的名稱，例如：主要業務DB、分析DB
databaseType	object	否	資料庫類型選項，有 MySQL、PostgreSQL、MSSQL、Oracle、MaiAgent postgresql: PostgreSQL ; mysql: MySQL ; maiagent: MaiAgent ; oracle: Oracle ; mssql: MSSQL;
databaseUrl	string	否	資料庫連線字串
includeTables	object	否	指定要查詢的資料表列表，格式: {"tables": ["table1", "table2"]}。MaiAgent 類型會自動從上傳的檔案中取得，不需要手動設定
isActive	boolean	否	停用後將不會在 Text-to-SQL 查詢中使用此資料庫

請求結構範例

{
  "name"?: string // 顯示用的名稱，例如：主要業務DB、分析DB (非必填)
  "databaseType"?:  // 資料庫類型選項，有 MySQL、PostgreSQL、MSSQL、Oracle、MaiAgent

* `postgresql` - PostgreSQL
* `mysql` - MySQL
* `maiagent` - MaiAgent
* `oracle` - Oracle
* `mssql` - MSSQL (非必填)
  {
  }
  "databaseUrl"?: string // 資料庫連線字串 (非必填)
  "includeTables"?: object // 指定要查詢的資料表列表，格式: {"tables": ["table1", "table2"]}。MaiAgent 類型會自動從上傳的檔案中取得，不需要手動設定 (非必填)
  "isActive"?: boolean // 停用後將不會在 Text-to-SQL 查詢中使用此資料庫 (非必填)
}

請求範例值

{
  "name": "範例名稱",
  "databaseType": {},
  "databaseUrl": "範例字串",
  "includeTables": null,
  "isActive": true
}

程式碼範例

Shell/Bash

# 呼叫 API 示例 (Shell)
curl -X PATCH "https://api.maiagent.ai/api/v1/chatbots/550e8400-e29b-41d4-a716-446655440000/databases/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "範例名稱",
    "databaseType": {},
    "databaseUrl": "範例字串",
    "includeTables": null,
    "isActive": true
  }'

# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。

JavaScript

Python

PHP

回應內容

狀態碼: 200

回應結構範例

{
  "id": string (uuid)
  "name": string // 顯示用的名稱，例如：主要業務DB、分析DB
  "databaseType":  // 資料庫類型選項，有 MySQL、PostgreSQL、MSSQL、Oracle、MaiAgent

* `postgresql` - PostgreSQL
* `mysql` - MySQL
* `maiagent` - MaiAgent
* `oracle` - Oracle
* `mssql` - MSSQL
  {
  }
  "databaseUrl": string // 資料庫連線字串
  "includeTables"?: object // 指定要查詢的資料表列表，格式: {"tables": ["table1", "table2"]}。MaiAgent 類型會自動從上傳的檔案中取得，不需要手動設定 (非必填)
  "isActive"?: boolean // 停用後將不會在 Text-to-SQL 查詢中使用此資料庫 (非必填)
  "createdAt": string (timestamp)
  "updatedAt": string (timestamp)
}

回應範例值

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "回應字串",
  "databaseType": {},
  "databaseUrl": "回應字串",
  "includeTables": null,
  "isActive": false,
  "createdAt": "回應字串",
  "updatedAt": "回應字串"
}

---

刪除資料庫配置

DELETE /api/v1/chatbots/{chatbotPk}/databases/{id}/

參數

參數名稱	必填	類型	說明
chatbotPk	✅	string	A UUID string identifying this Chatbot ID
id	✅	string	A UUID string identifying this Chatbot 資料庫配置.

程式碼範例

Shell/Bash

# 呼叫 API 示例 (Shell)
curl -X DELETE "https://api.maiagent.ai/api/v1/chatbots/550e8400-e29b-41d4-a716-446655440000/databases/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。

JavaScript

Python

PHP

回應內容

狀態碼	說明
204	No response body

---