Databases

The databases this agent answers from.

Base URL https://futuresmart.ai/database-agent/api · every request sends X-API-Key. Samples read the key from DATABASE_AGENT_API_KEY. All endpoints

List Databases

GET/v1/agents/{agent_id}/databases

Credential Database Agent API key for this agent (X-API-Key)

Path parameters

Name	Type	Description
`agent_id`required	`string`

Other responses

422 Validation Error

import os
import requests

API_ROOT = "https://futuresmart.ai/database-agent/api"
API_KEY = os.environ["DATABASE_AGENT_API_KEY"]

r = requests.get(
    f"{API_ROOT}/v1/agents/YOUR_AGENT_ID/databases",
    headers={"X-API-Key": API_KEY},
    timeout=120,
)
r.raise_for_status()
print(r.json())

const API_ROOT = "https://futuresmart.ai/database-agent/api";

const res = await fetch(`${API_ROOT}/v1/agents/YOUR_AGENT_ID/databases`, {
  method: "GET",
  headers: { "X-API-Key": process.env.DATABASE_AGENT_API_KEY },
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
console.log(await res.json());

curl -X GET "https://futuresmart.ai/database-agent/api/v1/agents/YOUR_AGENT_ID/databases" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY"

Add Database

POST/v1/agents/{agent_id}/databases

Credential Database Agent API key for this agent (X-API-Key)

Path parameters

Name	Type	Description
`agent_id`required	`string`

Request body · application/json (optional)

Name	Type	Description
`db_host`required	`string`	Database host address
`db_name`required	`string`	Database name
`db_user`required	`string`	Database username
`db_password`required	`string`	Database password
`db_port`	`integer \| null`	Database port (default: the engine's — 3306 MySQL, 5432 PostgreSQL)
`db_engine`	`string`	Database engine (mysql, postgresql)Default: mysql
`description`	`string \| null`	Routing description (optional — blank → auto-generate)

Other responses

422 Validation Error

import os
import requests

API_ROOT = "https://futuresmart.ai/database-agent/api"
API_KEY = os.environ["DATABASE_AGENT_API_KEY"]

r = requests.post(
    f"{API_ROOT}/v1/agents/YOUR_AGENT_ID/databases",
    headers={"X-API-Key": API_KEY},
    json={
        "db_host": "<db_host>",
        "db_name": "<db_name>",
        "db_user": "<db_user>",
        "db_password": "<db_password>",
        "db_engine": "mysql",
    },
    timeout=120,
)
r.raise_for_status()
print(r.json())

const API_ROOT = "https://futuresmart.ai/database-agent/api";

const res = await fetch(`${API_ROOT}/v1/agents/YOUR_AGENT_ID/databases`, {
  method: "POST",
  headers: { "X-API-Key": process.env.DATABASE_AGENT_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({
    "db_host": "<db_host>",
    "db_name": "<db_name>",
    "db_user": "<db_user>",
    "db_password": "<db_password>",
    "db_engine": "mysql"
  }),
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
console.log(await res.json());

curl -X POST "https://futuresmart.ai/database-agent/api/v1/agents/YOUR_AGENT_ID/databases" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "db_host": "<db_host>",
    "db_name": "<db_name>",
    "db_user": "<db_user>",
    "db_password": "<db_password>",
    "db_engine": "mysql"
  }'

Example request body

JSON

{
  "db_host": "<db_host>",
  "db_name": "<db_name>",
  "db_user": "<db_user>",
  "db_password": "<db_password>",
  "db_engine": "mysql"
}

Check Databases

POST/v1/agents/{agent_id}/databases/check

Health-check every DB (connection status + response time + description status).

Credential Database Agent API key for this agent (X-API-Key)

Path parameters

Name	Type	Description
`agent_id`required	`string`

Other responses

422 Validation Error

import os
import requests

API_ROOT = "https://futuresmart.ai/database-agent/api"
API_KEY = os.environ["DATABASE_AGENT_API_KEY"]

r = requests.post(
    f"{API_ROOT}/v1/agents/YOUR_AGENT_ID/databases/check",
    headers={"X-API-Key": API_KEY},
    timeout=120,
)
r.raise_for_status()
print(r.json())

const API_ROOT = "https://futuresmart.ai/database-agent/api";

const res = await fetch(`${API_ROOT}/v1/agents/YOUR_AGENT_ID/databases/check`, {
  method: "POST",
  headers: { "X-API-Key": process.env.DATABASE_AGENT_API_KEY },
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
console.log(await res.json());

curl -X POST "https://futuresmart.ai/database-agent/api/v1/agents/YOUR_AGENT_ID/databases/check" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY"

Bulk Import

POST/v1/agents/{agent_id}/databases/bulk

Credential Database Agent API key for this agent (X-API-Key)

Path parameters

Name	Type	Description
`agent_id`required	`string`

Request body · multipart/form-data

Name	Type	Description
`file`required	`string`

Other responses

422 Validation Error

import os
import requests

API_ROOT = "https://futuresmart.ai/database-agent/api"
API_KEY = os.environ["DATABASE_AGENT_API_KEY"]

r = requests.post(
    f"{API_ROOT}/v1/agents/YOUR_AGENT_ID/databases/bulk",
    headers={"X-API-Key": API_KEY},
    data={"file": "<file>"},
    timeout=120,
)
r.raise_for_status()
print(r.json())

import { readFile } from "node:fs/promises";

const API_ROOT = "https://futuresmart.ai/database-agent/api";

const form = new FormData();
form.append("file", "<file>");

const res = await fetch(`${API_ROOT}/v1/agents/YOUR_AGENT_ID/databases/bulk`, {
  method: "POST",
  headers: { "X-API-Key": process.env.DATABASE_AGENT_API_KEY },
  body: form,
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
console.log(await res.json());

curl -X POST "https://futuresmart.ai/database-agent/api/v1/agents/YOUR_AGENT_ID/databases/bulk" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY" \
  -F "file=<file>"

Bulk Delete

POST/v1/agents/{agent_id}/databases/bulk-delete

Delete multiple databases (and their scoped metadata) in a single action. Body: {"db_ids": ["DB_...", "DB_..."]}. Best-effort per DB; returns per-DB results + a summary.

Credential Database Agent API key for this agent (X-API-Key)

Path parameters

Name	Type	Description
`agent_id`required	`string`

Request body · application/json

Name	Type	Description
`db_ids`required	`array<string>`	Database IDs to delete

Other responses

422 Validation Error

import os
import requests

API_ROOT = "https://futuresmart.ai/database-agent/api"
API_KEY = os.environ["DATABASE_AGENT_API_KEY"]

r = requests.post(
    f"{API_ROOT}/v1/agents/YOUR_AGENT_ID/databases/bulk-delete",
    headers={"X-API-Key": API_KEY},
    json={
        "db_ids": ["DB_3F9A1C2B", "DB_5C1E9A22"],
    },
    timeout=120,
)
r.raise_for_status()
print(r.json())

const API_ROOT = "https://futuresmart.ai/database-agent/api";

const res = await fetch(`${API_ROOT}/v1/agents/YOUR_AGENT_ID/databases/bulk-delete`, {
  method: "POST",
  headers: { "X-API-Key": process.env.DATABASE_AGENT_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({
    "db_ids": [
      "DB_3F9A1C2B",
      "DB_5C1E9A22"
    ]
  }),
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
console.log(await res.json());

curl -X POST "https://futuresmart.ai/database-agent/api/v1/agents/YOUR_AGENT_ID/databases/bulk-delete" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "db_ids": [
      "DB_3F9A1C2B",
      "DB_5C1E9A22"
    ]
  }'

Example request body

JSON

{
  "db_ids": [
    "DB_3F9A1C2B",
    "DB_5C1E9A22"
  ]
}

Generate Description

POST/v1/agents/{agent_id}/databases/{db_id}/description/generate

Credential Database Agent API key for this agent (X-API-Key)

Path parameters

Name	Type	Description
`agent_id`required	`string`
`db_id`required	`string`

Other responses

422 Validation Error

import os
import requests

API_ROOT = "https://futuresmart.ai/database-agent/api"
API_KEY = os.environ["DATABASE_AGENT_API_KEY"]

r = requests.post(
    f"{API_ROOT}/v1/agents/YOUR_AGENT_ID/databases/YOUR_DB_ID/description/generate",
    headers={"X-API-Key": API_KEY},
    timeout=120,
)
r.raise_for_status()
print(r.json())

const API_ROOT = "https://futuresmart.ai/database-agent/api";

const res = await fetch(`${API_ROOT}/v1/agents/YOUR_AGENT_ID/databases/YOUR_DB_ID/description/generate`, {
  method: "POST",
  headers: { "X-API-Key": process.env.DATABASE_AGENT_API_KEY },
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
console.log(await res.json());

curl -X POST "https://futuresmart.ai/database-agent/api/v1/agents/YOUR_AGENT_ID/databases/YOUR_DB_ID/description/generate" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY"

Poll Description

GET/v1/agents/{agent_id}/databases/{db_id}/description/generate/{job_id}

Credential Database Agent API key for this agent (X-API-Key)

Path parameters

Name	Type	Description
`agent_id`required	`string`
`db_id`required	`string`
`job_id`required	`string`

Other responses

422 Validation Error

import os
import requests

API_ROOT = "https://futuresmart.ai/database-agent/api"
API_KEY = os.environ["DATABASE_AGENT_API_KEY"]

r = requests.get(
    f"{API_ROOT}/v1/agents/YOUR_AGENT_ID/databases/YOUR_DB_ID/description/generate/YOUR_JOB_ID",
    headers={"X-API-Key": API_KEY},
    timeout=120,
)
r.raise_for_status()
print(r.json())

const API_ROOT = "https://futuresmart.ai/database-agent/api";

const res = await fetch(`${API_ROOT}/v1/agents/YOUR_AGENT_ID/databases/YOUR_DB_ID/description/generate/YOUR_JOB_ID`, {
  method: "GET",
  headers: { "X-API-Key": process.env.DATABASE_AGENT_API_KEY },
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
console.log(await res.json());

curl -X GET "https://futuresmart.ai/database-agent/api/v1/agents/YOUR_AGENT_ID/databases/YOUR_DB_ID/description/generate/YOUR_JOB_ID" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY"

Get Database

GET/v1/agents/{agent_id}/databases/{db_id}

Credential Database Agent API key for this agent (X-API-Key)

Path parameters

Name	Type	Description
`agent_id`required	`string`
`db_id`required	`string`

Other responses

422 Validation Error

import os
import requests

API_ROOT = "https://futuresmart.ai/database-agent/api"
API_KEY = os.environ["DATABASE_AGENT_API_KEY"]

r = requests.get(
    f"{API_ROOT}/v1/agents/YOUR_AGENT_ID/databases/YOUR_DB_ID",
    headers={"X-API-Key": API_KEY},
    timeout=120,
)
r.raise_for_status()
print(r.json())

const API_ROOT = "https://futuresmart.ai/database-agent/api";

const res = await fetch(`${API_ROOT}/v1/agents/YOUR_AGENT_ID/databases/YOUR_DB_ID`, {
  method: "GET",
  headers: { "X-API-Key": process.env.DATABASE_AGENT_API_KEY },
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
console.log(await res.json());

curl -X GET "https://futuresmart.ai/database-agent/api/v1/agents/YOUR_AGENT_ID/databases/YOUR_DB_ID" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY"

Update Database

PATCH/v1/agents/{agent_id}/databases/{db_id}

Credential Database Agent API key for this agent (X-API-Key)

Path parameters

Name	Type	Description
`agent_id`required	`string`
`db_id`required	`string`

Request body · application/json (optional)

Name	Type	Description
`db_host`	`string \| null`
`db_name`	`string \| null`
`db_user`	`string \| null`
`db_password`	`string \| null`
`db_port`	`integer \| null`
`db_engine`	`string \| null`
`description`	`string \| null`

Other responses

422 Validation Error

import os
import requests

API_ROOT = "https://futuresmart.ai/database-agent/api"
API_KEY = os.environ["DATABASE_AGENT_API_KEY"]

r = requests.patch(
    f"{API_ROOT}/v1/agents/YOUR_AGENT_ID/databases/YOUR_DB_ID",
    headers={"X-API-Key": API_KEY},
    json={},
    timeout=120,
)
r.raise_for_status()
print(r.json())

const API_ROOT = "https://futuresmart.ai/database-agent/api";

const res = await fetch(`${API_ROOT}/v1/agents/YOUR_AGENT_ID/databases/YOUR_DB_ID`, {
  method: "PATCH",
  headers: { "X-API-Key": process.env.DATABASE_AGENT_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({}),
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
console.log(await res.json());

curl -X PATCH "https://futuresmart.ai/database-agent/api/v1/agents/YOUR_AGENT_ID/databases/YOUR_DB_ID" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Example request body

JSON

{}

Delete Database

DELETE/v1/agents/{agent_id}/databases/{db_id}

Credential Database Agent API key for this agent (X-API-Key)

Path parameters

Name	Type	Description
`agent_id`required	`string`
`db_id`required	`string`

Other responses

422 Validation Error

import os
import requests

API_ROOT = "https://futuresmart.ai/database-agent/api"
API_KEY = os.environ["DATABASE_AGENT_API_KEY"]

r = requests.delete(
    f"{API_ROOT}/v1/agents/YOUR_AGENT_ID/databases/YOUR_DB_ID",
    headers={"X-API-Key": API_KEY},
    timeout=120,
)
r.raise_for_status()
print(r.json())

const API_ROOT = "https://futuresmart.ai/database-agent/api";

const res = await fetch(`${API_ROOT}/v1/agents/YOUR_AGENT_ID/databases/YOUR_DB_ID`, {
  method: "DELETE",
  headers: { "X-API-Key": process.env.DATABASE_AGENT_API_KEY },
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
console.log(await res.json());

curl -X DELETE "https://futuresmart.ai/database-agent/api/v1/agents/YOUR_AGENT_ID/databases/YOUR_DB_ID" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY"

Update Database Status

PATCH/v1/agents/{agent_id}/databases/{db_id}/status

Credential Database Agent API key for this agent (X-API-Key)

Path parameters

Name	Type	Description
`agent_id`required	`string`
`db_id`required	`string`

Request body · application/json (optional)

Name	Type	Description
`is_active`required	`boolean`	Enable (true) or disable (false) the database

Other responses

422 Validation Error

import os
import requests

API_ROOT = "https://futuresmart.ai/database-agent/api"
API_KEY = os.environ["DATABASE_AGENT_API_KEY"]

r = requests.patch(
    f"{API_ROOT}/v1/agents/YOUR_AGENT_ID/databases/YOUR_DB_ID/status",
    headers={"X-API-Key": API_KEY},
    json={
        "is_active": False,
    },
    timeout=120,
)
r.raise_for_status()
print(r.json())

const API_ROOT = "https://futuresmart.ai/database-agent/api";

const res = await fetch(`${API_ROOT}/v1/agents/YOUR_AGENT_ID/databases/YOUR_DB_ID/status`, {
  method: "PATCH",
  headers: { "X-API-Key": process.env.DATABASE_AGENT_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({
    "is_active": false
  }),
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
console.log(await res.json());

curl -X PATCH "https://futuresmart.ai/database-agent/api/v1/agents/YOUR_AGENT_ID/databases/YOUR_DB_ID/status" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "is_active": false
  }'

Example request body

JSON

{
  "is_active": false
}

Update Database Description

PATCH/v1/agents/{agent_id}/databases/{db_id}/description

Credential Database Agent API key for this agent (X-API-Key)

Path parameters

Name	Type	Description
`agent_id`required	`string`
`db_id`required	`string`

Request body · application/json (optional)

Name	Type	Description
`description`required	`string`	Routing description

Other responses

422 Validation Error

import os
import requests

API_ROOT = "https://futuresmart.ai/database-agent/api"
API_KEY = os.environ["DATABASE_AGENT_API_KEY"]

r = requests.patch(
    f"{API_ROOT}/v1/agents/YOUR_AGENT_ID/databases/YOUR_DB_ID/description",
    headers={"X-API-Key": API_KEY},
    json={
        "description": "<description>",
    },
    timeout=120,
)
r.raise_for_status()
print(r.json())

const API_ROOT = "https://futuresmart.ai/database-agent/api";

const res = await fetch(`${API_ROOT}/v1/agents/YOUR_AGENT_ID/databases/YOUR_DB_ID/description`, {
  method: "PATCH",
  headers: { "X-API-Key": process.env.DATABASE_AGENT_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({
    "description": "<description>"
  }),
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
console.log(await res.json());

curl -X PATCH "https://futuresmart.ai/database-agent/api/v1/agents/YOUR_AGENT_ID/databases/YOUR_DB_ID/description" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "<description>"
  }'

Example request body

JSON

{
  "description": "<description>"
}