Agent

Read and change the agent's own settings.

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 the agent

GET/v1/agents/{agent_id}

Get a specific agent by ID

The response includes the owner_id (email) of the agent.

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

Path parameters

Name	Type	Description
`agent_id`required	`string`	Agent 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",
    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`, {
  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" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY"

Replace the agent's settings

PUT/v1/agents/{agent_id}

Update an agent (full update - replaces all fields)

Gets owner_id (email) from Google Auth token to verify ownership.

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

Path parameters

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

Request body · application/json (optional)

Name	Type	Description
`agent_name`	`string \| null`	Name of the agent
`system_prompt`	`string \| null`	System prompt for the agent
`greet_message`	`string \| null`	Greeting message
`provider`	`string \| null`	LLM provider
`model`	`string \| null`	Model name
`temperature`	`number \| null`	Temperature for LLM
`show_sql_query`	`boolean \| null`	If true, the chat response will include the generated SQL query
`show_db_result`	`boolean \| null`	If true, the chat response will include the raw DB result rows

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.put(
    f"{API_ROOT}/v1/agents/YOUR_AGENT_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`, {
  method: "PUT",
  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 PUT "https://futuresmart.ai/database-agent/api/v1/agents/YOUR_AGENT_ID" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Example request body

JSON

{}

Update the agent's settings

PATCH/v1/agents/{agent_id}

Partially update an agent (only updates provided fields)

Gets owner_id (email) from Google Auth token to verify ownership.

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

Path parameters

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

Request body · application/json (optional)

Name	Type	Description
`agent_name`	`string \| null`	Name of the agent
`system_prompt`	`string \| null`	System prompt for the agent
`greet_message`	`string \| null`	Greeting message
`provider`	`string \| null`	LLM provider
`model`	`string \| null`	Model name
`temperature`	`number \| null`	Temperature for LLM
`show_sql_query`	`boolean \| null`	If true, the chat response will include the generated SQL query
`show_db_result`	`boolean \| null`	If true, the chat response will include the raw DB result rows

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",
    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`, {
  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" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Example request body

JSON

{}

Get the agent's model configuration

GET/v1/agents/{agent_id}/config

Get agent configuration including nodes and agent parameters

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

Path parameters

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

Query parameters

Name	Type	Description
`fields`	`string \| null`	Comma-separated list of fields to return (e.g., nodes,agent_params)
`node_name`	`string \| null`	Filter specific node configuration

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

Set per-step model configuration

POST/v1/agents/{agent_id}/config/nodes

Upsert (create or update) node configurations for an agent

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

Path parameters

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

Request body · application/json (optional)

Name	Type	Description
`owner_id`	`string \| null`	User ID (optional if using auth token)
`configs`required	`array<NodeConfig>`	List of node configurations to upsert
`↳ node_name`required	`string`	Node name (must be one of: refine, select_and_fewshots, sql_gen, sql_exec, final_answer_node, graph_json_node)
`↳ provider`required	`string`	LLM provider (e.g., openai, anthropic, groq)
`↳ model`required	`string`	Model name (e.g., gpt-4o, gpt-4o-mini, claude-3-5-sonnet)
`↳ temperature`	`number \| null`	Temperature for LLM
`↳ prompt`	`string \| null`	Custom prompt for this node

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/config/nodes",
    headers={"X-API-Key": API_KEY},
    json={
        "configs": [{
            "node_name": "<node_name>",
            "provider": "<provider>",
            "model": "<model>",
        }],
    },
    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/config/nodes`, {
  method: "POST",
  headers: { "X-API-Key": process.env.DATABASE_AGENT_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({
    "configs": [
      {
        "node_name": "<node_name>",
        "provider": "<provider>",
        "model": "<model>"
      }
    ]
  }),
});
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/config/nodes" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "configs": [
      {
        "node_name": "<node_name>",
        "provider": "<provider>",
        "model": "<model>"
      }
    ]
  }'

Example request body

JSON

{
  "configs": [
    {
      "node_name": "<node_name>",
      "provider": "<provider>",
      "model": "<model>"
    }
  ]
}

Update agent parameters

PATCH/v1/agents/{agent_id}/config/params

Partially update agent parameters

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

Path parameters

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

Request body · application/json (optional)

Name	Type	Description
`owner_id`	`string \| null`	Owner ID (optional if using auth token)
`agent_name`	`string \| null`	Name of the agent
`system_prompt`	`string \| null`	System prompt for the agent
`service_description`	`string \| null`	Service description for the agent
`greet_message`	`string \| null`	Greeting message
`debug_info`	`boolean \| null`	Enable debug information
`show_sql_query`	`boolean \| null`	If true, the chat response includes the generated SQL query
`show_db_result`	`boolean \| null`	If true, the chat response includes the raw DB result rows
`graph_output`	`boolean \| null`	Enable graph output
`allowed_graphs`	`array<string> \| null`	List of allowed graph types (e.g., bar, line, pie)
`follow_up`	`boolean \| null`	Suggest follow-up questions after each answer
`voice_input_enabled`	`boolean \| null`	Offer speech input in the ask box
`voice_output_enabled`	`boolean \| null`	Offer read-aloud on each answer
`suggested_questions`	`array<string> \| null`	Starter questions shown before the first message
`max_query_execution_time`	`integer \| null`	Maximum query execution time in seconds
`enable_query_caching`	`boolean \| null`	Enable query caching
`is_public`	`boolean \| null`	Allow the embedded widget to be used without signing in
`allowed_domains`	`array<string> \| null`	Domains the widget may be embedded on (e.g. ['example.com', '*.example.com']). Empty means any domain
`fullscreen_is_public`	`boolean \| null`	Allow the full-screen share link to be used without signing in
`fullscreen_allowed_domains`	`array<string> \| null`	Domains the full-screen link may be opened from. Empty means any domain

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/config/params",
    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/config/params`, {
  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/config/params" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Example request body

JSON

{}

Reset a step to its default configuration

DELETE/v1/agents/{agent_id}/config/nodes/{node_name}

Delete a node configuration

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

Path parameters

Name	Type	Description
`agent_id`required	`string`	Agent ID
`node_name`required	`string`	Node name (must be one of the valid LangGraph nodes)

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/config/nodes/YOUR_NODE_NAME",
    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/config/nodes/YOUR_NODE_NAME`, {
  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/config/nodes/YOUR_NODE_NAME" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY"