创建数据表
创建数据表
支持通过该 API 接口,为 Agent 创建新的数据表及其表字段。
请求方式
POST
调用地址
https://api-${endpoint}.gptbots.ai/v1/database/create-table
调用验证
详情参见 API 概述的鉴权方式说明。
请求
请求示例
curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/database/create-table' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
"name": "test_api",
"description": "测全部数据库api",
"fields": [
{
"name": "id",
"description": "id",
"type": "TEXT",
"required": true,
"unique": true
},
{
"name": "boolean",
"description": "boolean",
"type": "BOOLEAN",
"required": true,
"unique": false
},
{
"name": "int",
"description": "int",
"type": "INT",
"required": true,
"unique": true
},
{
"name": "datetime",
"description": "datetime",
"type": "DATETIME",
"required": true,
"unique": false
},
{
"name": "float",
"description": "float",
"type": "FLOAT",
"required": false,
"unique": false
}
]
}'
curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/database/create-table' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
"name": "test_api",
"description": "测全部数据库api",
"fields": [
{
"name": "id",
"description": "id",
"type": "TEXT",
"required": true,
"unique": true
},
{
"name": "boolean",
"description": "boolean",
"type": "BOOLEAN",
"required": true,
"unique": false
},
{
"name": "int",
"description": "int",
"type": "INT",
"required": true,
"unique": true
},
{
"name": "datetime",
"description": "datetime",
"type": "DATETIME",
"required": true,
"unique": false
},
{
"name": "float",
"description": "float",
"type": "FLOAT",
"required": false,
"unique": false
}
]
}'
此代碼塊在浮窗中顯示
请求头
| 字段 | 类型 | 描述 |
|---|---|---|
| Authorization | Bearer ${API Key} | 使用 Authorization: Bearer ${API Key}进行调用验证,请在 API 密钥页面获取密钥作为 API Key。 |
| Content-Type | application/json | 数据类型,取值为 application/json。 |
请求体
| 字段 | 类型 | 必填 | 描述 |
|---|---|---|---|
| name | string | 是 | 表名称:64 个字符,a~z/数字和下划线,字母开头。 |
| description | string | 是 | 表描述:128 个字符,让 LLM 理解该表的数据构成。 |
| fields | array | 是 | 表字段数组。 |
| fields[].name | string | 是 | 字段名称:64 个字符,a~z/数字和下划线。 |
| fields[].description | string | 是 | 字段描述:128 个字符,,让 LLM 理解该表的数据构成。 |
| fields[].type | string | 是 | 数据类型:TEXT/INT/FLOAT/DATETIME/BOOLEAN。 |
| fields[].required | boolean | 否 | 必要性:true/false。 |
| fields[].unique | boolean | 否 | 唯一性:true/false。 |
响应
响应示例
"673e9c7a9f7bc178002dbce8"
"673e9c7a9f7bc178002dbce8"
此代碼塊在浮窗中顯示
成功响应
| 字段 | 类型 | 描述 |
|---|---|---|
| code | int | 消息的类型编码。 |
| message | string | 消息描述。 |
| data | object | 回复内容,数据表的唯一标识。 |
失败响应
| 字段 | 类型 | 描述 |
|---|---|---|
| code | int | 错误码。 |
| message | string | 错误详情。 |
错误码
| Code | Message |
|---|---|
| 40000 | 参数错误 |
| 40008 | Agent RPM 请求超出限制,请联系服务提供商以提升限制 |
| 40127 | 开发者认证失败 |
| 40353 | 此功能仅在升级套餐后可用 |
| 403100 | 表名无效 |
| 403103 | 字段名称无效 |
| 50000 | 系统内部错误 |
