Datenbanktabellen auflisten

Mit dieser API können Sie die Liste aller Datenbanktabellen eines bestimmten Agenten abrufen. Zurückgegeben werden die grundlegenden Informationen jeder Tabelle (Name, Beschreibung, Anzahl der Felder, Datenmenge usw.).

Anfragemethode

POST

Endpoint

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

Authentifizierung

Weitere Informationen zur Authentifizierung finden Sie in der Beschreibung zur API-Übersicht.

Anfrage

Beispielanfrage

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

Dieser Codeblock im schwebenden Fenster

Anfrage-Header

Feld	Typ	Beschreibung
Authorization	Bearer ${API Key}	Für die Authentifizierung verwenden Sie Authorization: Bearer ${API Key}. Den API-Schlüssel erhalten Sie auf der API-Key-Seite.
Content-Type	application/json	Datentyp, der Wert ist application/json.

Anfrage-Body

Feld	Typ	Erforderlich	Beschreibung
agent_id	string	Ja	Eindeutige Kennung des Agenten.

Antwort

Beispielantwort

{ "tables": [ { "table_id": "680d1a2b3c4d5e6f7a8b9c0d", "name": "Kundeninformationstabelle", "description": "Speichert grundlegende Kundeninformationen", "field_number": 8, "record_count": 1250 }, { "table_id": "680d1a2b3c4d5e6f7a8b9c0e", "name": "Bestelltabelle", "description": "Speichert Bestelldaten", "field_number": 12, "record_count": 5430 } ] }

                      
                      {
    "tables": [
        {
            "table_id": "680d1a2b3c4d5e6f7a8b9c0d",
            "name": "Kundeninformationstabelle",
            "description": "Speichert grundlegende Kundeninformationen",
            "field_number": 8,
            "record_count": 1250
        },
        {
            "table_id": "680d1a2b3c4d5e6f7a8b9c0e",
            "name": "Bestelltabelle",
            "description": "Speichert Bestelldaten",
            "field_number": 12,
            "record_count": 5430
        }
    ]
}

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort

Feld	Typ	Beschreibung
tables	list	Liste der Datenbanktabellen.
table_id	string	Eindeutige Kennung der Datenbanktabelle.
name	string	Tabellenname.
description	string	Tabellenbeschreibung.
field_number	int	Anzahl der Felder.
record_count	int	Datenmenge (Anzahl der Datenzeilen).

Fehlerantwort

Feld	Typ	Beschreibung
code	int	Fehlercode.
message	string	Fehlerdetails.

Fehlercodes

Code	Message
40000	Ungültige Parameter
50000	Interner Systemfehler