创建数据表
最新更新:2024-11-21

创建数据表

支持通过该 API 接口,为 Bot 创建新的数据表及其表字段。

请求方式

POST

调用地址

https://api.gptbots.ai/v1/database/create-table

调用验证

详情参见 API 概述的鉴权方式说明。

请求

请求示例

curl -X POST https://api.gptbots.ai/v1/database/create-table \ -H 'Authorization: Bearer your_apikey' \ -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.gptbots.ai/v1/database/create-table \ 
  -H 'Authorization: Bearer your_apikey' \ 
  -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 ${token} 使用 Authorization: Bearer ${token}进行调用验证,请在 API 密钥页面获取密钥作为 token。
Content-Type application/json 数据类型,取值为 application/json。

请求体

字段 类型 必填 描述
name string 表名称:32 个字符,a~z/数字和下划线,字母开头。
description string 表描述:128 个字符,让 LLM 理解该表的数据构成。
fields array 表字段数组。
fields[].name string 字段名称:32 个字符,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。

响应

响应示例

{ "code": 0, "message": "OK", "data": "673e9c7a9f7bc178002dbce8" }
          {
    "code": 0,
    "message": "OK",
    "data": "673e9c7a9f7bc178002dbce8"
}

        
此代码块在浮窗中显示

成功响应

字段 类型 描述
code int 消息的类型编码。
message string 消息描述。
data object 回复内容,数据表的唯一标识。

失败响应

字段 类型 描述
code int 错误码。
message string 错误详情。

错误码

Code Message
40000 参数错误
50000 系统内部错误
403100 表名无效
403101 表描述无效
403102 字段数量无效
403103 字段名称无效
403104 字段描述无效
403105 字段类型无效
403111 字段数量超过限制
403108 表名已经存在