データベーステーブル一覧の取得
データベーステーブル一覧の取得
このAPIを使用すると、指定したエージェントのすべてのデータベーステーブル一覧を取得できます。各テーブルの基本情報（テーブル名、説明、フィールド数、データ量など）が返されます。
リクエストメソッド
POST
エンドポイント
https://api-${endpoint}.gptbots.ai/v1/database/tables/page
認証
認証方法の説明についてはAPI Overviewをご参照ください。
リクエスト
リクエスト例
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"
}'
このコードブロックをポップアップで表示
リクエストヘッダー
| フィールド | タイプ | 説明 |
|---|---|---|
| Authorization | Bearer ${API Key} | 認証には Authorization: Bearer ${API Key} を使用してください。トークンはAPIキーページから取得できます。 |
| Content-Type | application/json | データタイプ。値は application/json です。 |
リクエストボディ
| フィールド | タイプ | 必須 | 説明 |
|---|---|---|---|
| agent_id | string | はい | エージェントの一意の識別子。 |
レスポンス
レスポンス例
{
"tables": [
{
"table_id": "680d1a2b3c4d5e6f7a8b9c0d",
"name": "顧客情報テーブル",
"description": "顧客の基本情報を保存します",
"field_number": 8,
"record_count": 1250
},
{
"table_id": "680d1a2b3c4d5e6f7a8b9c0e",
"name": "注文テーブル",
"description": "注文データを保存します",
"field_number": 12,
"record_count": 5430
}
]
}
{
"tables": [
{
"table_id": "680d1a2b3c4d5e6f7a8b9c0d",
"name": "顧客情報テーブル",
"description": "顧客の基本情報を保存します",
"field_number": 8,
"record_count": 1250
},
{
"table_id": "680d1a2b3c4d5e6f7a8b9c0e",
"name": "注文テーブル",
"description": "注文データを保存します",
"field_number": 12,
"record_count": 5430
}
]
}
このコードブロックをポップアップで表示
成功時のレスポンス
| フィールド | タイプ | 説明 |
|---|---|---|
| tables | list | データベーステーブル一覧。 |
| table_id | string | データベーステーブルの一意の識別子。 |
| name | string | テーブル名。 |
| description | string | テーブルの説明。 |
| field_number | int | フィールド数。 |
| record_count | int | データ量（データ行数）。 |
エラー時のレスポンス
| フィールド | タイプ | 説明 |
|---|---|---|
| code | int | エラーコード。 |
| message | string | エラーの詳細。 |
エラーコード
| Code | Message |
|---|---|
| 40000 | パラメータエラー |
| 50000 | システム内部エラー |