获取数据库记录

支持通过该 API 接口，发送请求以获取指定数据表的分页记录数据。

请求方式

POST

调用地址

https://api.gptbots.ai/v1/database/records/page

调用验证

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

请求

请求示例

curl -X POST https://api.gptbots.ai/v1/database/records/page \ -H 'Authorization: Bearer your_apikey' \ -H 'Content-Type: application/json' \ -d '{ "table_id": "673d7d00ce119a7e9f47d152" "page": 1, "page_size": 10, "filter": { //用户自定义过滤条件和 keyword 必须二选一 "id": "1", "int": 100 }, "keyword":"keyword" }'

          curl -X POST https://api.gptbots.ai/v1/database/records/page \ 
  -H 'Authorization: Bearer your_apikey' \ 
  -H 'Content-Type: application/json' \ 
  -d '{
    "table_id": "673d7d00ce119a7e9f47d152"
    "page": 1,
    "page_size": 10,
    "filter": {         //用户自定义过滤条件和 keyword 必须二选一
        "id": "1",
        "int": 100
    },
    "keyword":"keyword"
    }'

此代码块在浮窗中显示

请求头

字段	类型	描述
Authorization	Bearer ${token}	使用 Authorization: Bearer ${token}进行调用验证，请在 API 密钥页面获取密钥作为 token。
Content-Type	application/json	数据类型，取值为 application/json。

请求体

字段	类型	必填	描述
table_id	string	是	表id。
page	int	是	页码数，即需要请求第几页，从 1 开始。
page_size	int	是	每页的数据量，范围 1-100。
filter	map	否	用户自定义过滤条件（例如：自定义唯一主键）。
keyword	string	否	关键词，支持模糊查询。

响应

响应示例

{ "code": 0, "message": "OK", "data": { "table_info": { "id": "673e9c7a9f7bc178002dbce8", "name": "test_api", "description": "测全部数据库api", "field_count": 5, "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 } ], "bot_id": "673e93aca7c4223becf6caf0", "project_id": "665465e2b5c78e6c7ab92d2b", "owner_id": "665465e2b5c78e6c7ab92d28" }, "records": [ { "id": "541278230707963208", "value": { "id": "1", "boolean": true, "int": 1, "datetime": "2029-10-01 12:00:00", "float": 2024.21 }, "created_at": 1732156566000, "updated_at": 1732156607000 } ], "total_count": 2 } }

          {
    "code": 0,
    "message": "OK",
    "data": {
        "table_info": {
            "id": "673e9c7a9f7bc178002dbce8",
            "name": "test_api",
            "description": "测全部数据库api",
            "field_count": 5,
            "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
                }
            ],
            "bot_id": "673e93aca7c4223becf6caf0",
            "project_id": "665465e2b5c78e6c7ab92d2b",
            "owner_id": "665465e2b5c78e6c7ab92d28"
        },
        "records": [
            {
                "id": "541278230707963208",
                "value": {
                    "id": "1",
                    "boolean": true,
                    "int": 1,
                    "datetime": "2029-10-01 12:00:00",
                    "float": 2024.21
                },
                "created_at": 1732156566000,
                "updated_at": 1732156607000
            }
        ],
        "total_count": 2
    }
}

此代码块在浮窗中显示

成功响应

字段	类型	描述
code	int	消息的类型编码。
message	string	消息描述。
total_count	int	总记录数。
records	array	数据记录数组。
records[].id	string	数据 ID。
records[].value	object	数据值。
records[].created_at	long	创建时间。
records[].updated_at	long	更新时间。
table_info	object	数据表的信息，包括以下属性：

tableInfo 属性

字段	类型	描述
id	string	数据表的唯一标识。
name	string	数据表名称。
description	string	数据表描述。
fieldCount	int	字段数量。
fields	array	字段数组，包含每个字段的详细信息。
fields[].name	string	字段名称。
fields[].description	string	字段描述。
fields[].type	string	数据类型，如 TEXT、INT、FLOAT 等。
fields[].required	boolean	是否为必填字段。
fields[].unique	boolean	是否唯一字段。
bot_id	string	botid。
project_id	string	项目 ID。
owner_id	string	数据表所有者 ID。

失败响应

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

错误码

Code	Message
40000	参数错误
50000	系统内部错误
403106	未找到表
403131	无权访问数据表