Lister les tables de base de données

Permet de récupérer la liste de toutes les tables de base de données d'un agent donné via cette API. Elle renvoie les informations de base de chaque table (nom, description, nombre de champs, quantité de données, etc.).

Méthode de requête

POST

Endpoint

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

Authentification

Pour plus de détails, veuillez consulter la description de la méthode d'authentification dans la Vue d'ensemble de l'API.

Requête

Exemple de requête

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"
}'

Ce bloc de code dans la fenêtre flottante

En-têtes de la requête

Champ	Type	Description
Authorization	Bearer ${API Key}	Utilisez Authorization: Bearer ${API Key} pour l'authentification. Obtenez la clé API depuis la page Clé API.
Content-Type	application/json	Type de données, la valeur est application/json.

Corps de la requête

Champ	Type	Obligatoire	Description
agent_id	string	Oui	Identifiant unique de l'agent.

Réponse

Exemple de réponse

{ "tables": [ { "table_id": "680d1a2b3c4d5e6f7a8b9c0d", "name": "Table d'informations client", "description": "Stocke les informations de base des clients", "field_number": 8, "record_count": 1250 }, { "table_id": "680d1a2b3c4d5e6f7a8b9c0e", "name": "Table des commandes", "description": "Stocke les données de commande", "field_number": 12, "record_count": 5430 } ] }

                      
                      {
    "tables": [
        {
            "table_id": "680d1a2b3c4d5e6f7a8b9c0d",
            "name": "Table d'informations client",
            "description": "Stocke les informations de base des clients",
            "field_number": 8,
            "record_count": 1250
        },
        {
            "table_id": "680d1a2b3c4d5e6f7a8b9c0e",
            "name": "Table des commandes",
            "description": "Stocke les données de commande",
            "field_number": 12,
            "record_count": 5430
        }
    ]
}

Ce bloc de code dans la fenêtre flottante

Réponse en cas de succès

Champ	Type	Description
tables	list	Liste des tables de base de données.
table_id	string	Identifiant unique de la table de base de données.
name	string	Nom de la table.
description	string	Description de la table.
field_number	int	Nombre de champs.
record_count	int	Quantité de données (nombre de lignes de données).

Réponse en cas d'échec

Champ	Type	Description
code	int	Code d'erreur.
message	string	Détails de l'erreur.

Codes d'erreur

Code	Message
40000	Paramètres invalides
50000	Erreur interne du système