Column value lookup

Columns whose stored values the agent looks up before it writes SQL.

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

Get High Cardinality Columns For Db

GET/v1/agents/{agent_id}/databases/{db_id}/tables/high-cardinality-columns

Get high-cardinality columns for an agent, scoped to a specific database.

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

Path parameters

Name	Type	Description
`agent_id`required	`string`	Agent ID
`db_id`required	`string`	Database ID

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/tables/high-cardinality-columns",
    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/tables/high-cardinality-columns`, {
  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/tables/high-cardinality-columns" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY"

Set High Cardinality Columns For Db

POST/v1/agents/{agent_id}/databases/{db_id}/tables/high-cardinality-columns

Set high-cardinality columns for an agent, scoped to a specific database.

Indexes the column values into the HC Qdrant collection (tagged with db_id), then merges the configuration into TableDescription. Mirrors the agent-global route but resolves the DB connection by db_id so the right database is read.

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

Path parameters

Name	Type	Description
`agent_id`required	`string`	Agent ID
`db_id`required	`string`	Database ID

Request body · application/json

Name	Type	Description
`columns`required	`array<HighCardinalityColumnItem>`	List of high cardinality columns
`↳ table_name`required	`string`	Table name
`↳ column_name`required	`string`	Column name

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/tables/high-cardinality-columns",
    headers={"X-API-Key": API_KEY},
    json={
        "columns": [{
            "table_name": "<table_name>",
            "column_name": "<column_name>",
        }],
    },
    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/tables/high-cardinality-columns`, {
  method: "POST",
  headers: { "X-API-Key": process.env.DATABASE_AGENT_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({
    "columns": [
      {
        "table_name": "<table_name>",
        "column_name": "<column_name>"
      }
    ]
  }),
});
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/tables/high-cardinality-columns" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "columns": [
      {
        "table_name": "<table_name>",
        "column_name": "<column_name>"
      }
    ]
  }'

Example request body

JSON

{
  "columns": [
    {
      "table_name": "<table_name>",
      "column_name": "<column_name>"
    }
  ]
}

Delete High Cardinality Columns For Db

DELETE/v1/agents/{agent_id}/databases/{db_id}/tables/high-cardinality-columns

Delete specific high-cardinality columns for an agent, scoped to a database.

Removes the columns from the config and best-effort deletes the matching db_id-scoped vectors from the HC Qdrant collection.

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

Path parameters

Name	Type	Description
`agent_id`required	`string`	Agent ID
`db_id`required	`string`	Database ID

Request body · application/json

Name	Type	Description
`columns`required	`array<HighCardinalityColumnItem>`	List of high cardinality columns
`↳ table_name`required	`string`	Table name
`↳ column_name`required	`string`	Column name

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/tables/high-cardinality-columns",
    headers={"X-API-Key": API_KEY},
    json={
        "columns": [{
            "table_name": "<table_name>",
            "column_name": "<column_name>",
        }],
    },
    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/tables/high-cardinality-columns`, {
  method: "DELETE",
  headers: { "X-API-Key": process.env.DATABASE_AGENT_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({
    "columns": [
      {
        "table_name": "<table_name>",
        "column_name": "<column_name>"
      }
    ]
  }),
});
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/tables/high-cardinality-columns" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "columns": [
      {
        "table_name": "<table_name>",
        "column_name": "<column_name>"
      }
    ]
  }'

Example request body

JSON

{
  "columns": [
    {
      "table_name": "<table_name>",
      "column_name": "<column_name>"
    }
  ]
}

Get All Hc Profiles For Db

GET/v1/agents/{agent_id}/databases/{db_id}/tables/hc-profile

Get stored HC column profiles for all profiled tables of a specific database.

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

Path parameters

Name	Type	Description
`agent_id`required	`string`	Agent ID
`db_id`required	`string`	Database ID

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/tables/hc-profile",
    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/tables/hc-profile`, {
  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/tables/hc-profile" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY"

Trigger Hc Profile For Db

POST/v1/agents/{agent_id}/databases/{db_id}/tables/hc-profile

Trigger automatic profiling of a specific database's tables.

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

Path parameters

Name	Type	Description
`agent_id`required	`string`	Agent ID
`db_id`required	`string`	Database ID

Request body · application/json (optional)

Name	Type	Description
`config`	`object \| null`
`↳ low_cardinality_threshold`	`integer \| null`	Default: 20
`↳ high_null_threshold`	`number \| null`	Default: 95
`↳ min_avg_text_len_for_hc`	`number \| null`	Default: 2
`↳ sample_limit`	`integer \| null`	Default: 5
`tables`	`array<string> \| null`
`auto_register_hc`	`boolean`	Default: true

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/tables/hc-profile",
    headers={"X-API-Key": API_KEY},
    json={
        "auto_register_hc": True,
    },
    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/tables/hc-profile`, {
  method: "POST",
  headers: { "X-API-Key": process.env.DATABASE_AGENT_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({
    "auto_register_hc": true
  }),
});
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/tables/hc-profile" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "auto_register_hc": true
  }'

Example request body

JSON

{
  "auto_register_hc": true
}

Delete All Hc Profiles For Db

DELETE/v1/agents/{agent_id}/databases/{db_id}/tables/hc-profile

Delete all stored HC column profiles for a specific database (and its Qdrant vectors).

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

Path parameters

Name	Type	Description
`agent_id`required	`string`	Agent ID
`db_id`required	`string`	Database ID

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/tables/hc-profile",
    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/tables/hc-profile`, {
  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/tables/hc-profile" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY"

Get Table Hc Profile For Db

GET/v1/agents/{agent_id}/databases/{db_id}/tables/{table_name}/hc-profile

Get the stored HC column profile for a specific table in a specific database.

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

Path parameters

Name	Type	Description
`agent_id`required	`string`	Agent ID
`db_id`required	`string`	Database ID
`table_name`required	`string`	Table name

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/tables/YOUR_TABLE_NAME/hc-profile",
    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/tables/YOUR_TABLE_NAME/hc-profile`, {
  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/tables/YOUR_TABLE_NAME/hc-profile" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY"

Delete Table Hc Profile For Db

DELETE/v1/agents/{agent_id}/databases/{db_id}/tables/{table_name}/hc-profile

Delete the stored HC column profile for a specific table in a specific database.

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

Path parameters

Name	Type	Description
`agent_id`required	`string`	Agent ID
`db_id`required	`string`	Database ID
`table_name`required	`string`	Table name

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/tables/YOUR_TABLE_NAME/hc-profile",
    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/tables/YOUR_TABLE_NAME/hc-profile`, {
  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/tables/YOUR_TABLE_NAME/hc-profile" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY"