Listar tablas de base de datos

Esta API permite obtener la lista de todas las tablas de base de datos de un agente o workflow determinado. Devuelve la información básica de cada tabla (nombre, descripción, número de campos, cantidad de datos, etc.).

Método de solicitud

POST

Endpoint

https://api-${endpoint}.gptbots.ai/v1/database/tables/page

Autenticación

Para obtener más información, consulte la descripción del método de autenticación en Visión general de la API.

Solicitud

Ejemplo de solicitud

curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/database/tables/page' \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "agent_id": "680d1a2b3c4d5e6f7a8b9c0d" }'

                      
                      curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/database/tables/page' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
    "agent_id": "680d1a2b3c4d5e6f7a8b9c0d"
}'

Este bloque de código en una ventana flotante

Cabeceras de la solicitud

Campo	Tipo	Descripción
Authorization	Bearer ${API Key}	Se utiliza `Authorization: Bearer ${API Key}` para la autenticación. La clave de API se obtiene en la página «API Key».
Content-Type	application/json	Tipo de contenido; el valor es `application/json`.

Cuerpo de la solicitud

Campo	Tipo	Obligatorio	Descripción
agent_id	string	Sí	Se puede pasar agent_id o workflow_id.

Respuesta

Ejemplo de respuesta

{ "tables": [ { "table_id": "680d1a2b3c4d5e6f7a8b9c0d", "name": "Tabla de información de clientes", "description": "Almacena la información básica de los clientes", "field_number": 8, "record_count": 1250 }, { "table_id": "680d1a2b3c4d5e6f7a8b9c0e", "name": "Tabla de pedidos", "description": "Almacena los datos de pedidos", "field_number": 12, "record_count": 5430 } ] }

                      
                      {
    "tables": [
        {
            "table_id": "680d1a2b3c4d5e6f7a8b9c0d",
            "name": "Tabla de información de clientes",
            "description": "Almacena la información básica de los clientes",
            "field_number": 8,
            "record_count": 1250
        },
        {
            "table_id": "680d1a2b3c4d5e6f7a8b9c0e",
            "name": "Tabla de pedidos",
            "description": "Almacena los datos de pedidos",
            "field_number": 12,
            "record_count": 5430
        }
    ]
}

Este bloque de código en una ventana flotante

Respuesta correcta

Campo	Tipo	Descripción
tables	list	Lista de tablas de base de datos.
table_id	string	Identificador único de la tabla de base de datos.
name	string	Nombre de la tabla.
description	string	Descripción de la tabla.
field_number	int	Número de campos.
record_count	int	Cantidad de datos (número de filas de datos).

Respuesta de error

Campo	Tipo	Descripción
code	int	Código de error.
message	string	Detalles del error.

Códigos de error

Code	Message
40000	Parámetros no válidos
50000	Error interno del sistema