Chat

Ask questions and follow-ups. Every call is scoped to one agent.

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

Ask a question

POST/v1/agents/{agent_id}/chat

Send a chat message to an agent

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
`stream`	`boolean`	Enable streaming responseDefault: false

Request body · application/json (optional)

Name	Type	Description
`user_id`	`string \| null`	End-user ID; honored only for master-key (server-to-server) callers
`query`required	`string`	Natural language query
`session_id`	`string \| null`	Session ID (creates new if not provided)
`debug_info`	`boolean \| null`	Include debug information in response. Omit to use the agent's saved setting.
`chart_output`	`boolean \| null`	Include chart output in response. Omit to use the agent's saved setting.
`allowed_charts`	`array<string> \| null`	List of allowed chart types. Omit to use the agent's saved setting.
`follow_up`	`boolean \| null`	If true, also generate exactly two short follow-up questions for this turn. Omit to use the agent's saved setting.

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/chat",
    headers={"X-API-Key": API_KEY},
    json={
        "query": "How many orders were placed last month?",
    },
    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/chat`, {
  method: "POST",
  headers: { "X-API-Key": process.env.DATABASE_AGENT_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({
    "query": "How many orders were placed last month?"
  }),
});
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/chat" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "How many orders were placed last month?"
  }'

Example request body

JSON

{
  "query": "How many orders were placed last month?"
}

Get a conversation's messages

GET/v1/agents/{agent_id}/sessions/{session_id}/messages

Get message history for a session

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

Path parameters

Name	Type	Description
`agent_id`required	`string`	Agent ID
`session_id`required	`string`	Session 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/sessions/YOUR_SESSION_ID/messages",
    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/sessions/YOUR_SESSION_ID/messages`, {
  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/sessions/YOUR_SESSION_ID/messages" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY"

Ask a follow-up in a conversation

POST/v1/agents/{agent_id}/sessions/{session_id}/messages

Send a message to an existing session

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

Path parameters

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

Query parameters

Name	Type	Description
`stream`	`boolean`	Enable streaming responseDefault: false

Request body · application/json (optional)

Name	Type	Description
`user_id`	`string \| null`	End-user ID; honored only for master-key (server-to-server) callers
`query`required	`string`	Natural language query
`debug_info`	`boolean \| null`	Include debug information in response. Omit to use the agent's saved setting.
`chart_output`	`boolean \| null`	Include chart output in response. Omit to use the agent's saved setting.
`allowed_charts`	`array<string> \| null`	List of allowed chart types. Omit to use the agent's saved setting.
`follow_up`	`boolean \| null`	If true, also generate exactly two short follow-up questions for this turn. Omit to use the agent's saved setting.

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/sessions/YOUR_SESSION_ID/messages",
    headers={"X-API-Key": API_KEY},
    json={
        "query": "How many orders were placed last month?",
    },
    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/sessions/YOUR_SESSION_ID/messages`, {
  method: "POST",
  headers: { "X-API-Key": process.env.DATABASE_AGENT_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({
    "query": "How many orders were placed last month?"
  }),
});
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/sessions/YOUR_SESSION_ID/messages" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "How many orders were placed last month?"
  }'

Example request body

JSON

{
  "query": "How many orders were placed last month?"
}

Rate an answer

POST/v1/agents/{agent_id}/feedback

Submit feedback on agent responses

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
`user_id`	`string \| null`	User ID (optional)
`session_id`required	`string`	Session ID
`chat_id`required	`string`	Chat message ID
`user_query`required	`string`	Original user query
`generated_query`required	`string`	Generated SQL query
`label`required	`string`	Feedback label: 'correct' or 'incorrect'
`corrected_query`	`string \| null`	Corrected SQL query (optional, for incorrect feedback)

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/feedback",
    headers={"X-API-Key": API_KEY},
    json={
        "session_id": "<session_id>",
        "chat_id": "<chat_id>",
        "user_query": "<user_query>",
        "generated_query": "<generated_query>",
        "label": "<label>",
    },
    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/feedback`, {
  method: "POST",
  headers: { "X-API-Key": process.env.DATABASE_AGENT_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({
    "session_id": "<session_id>",
    "chat_id": "<chat_id>",
    "user_query": "<user_query>",
    "generated_query": "<generated_query>",
    "label": "<label>"
  }),
});
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/feedback" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "session_id": "<session_id>",
    "chat_id": "<chat_id>",
    "user_query": "<user_query>",
    "generated_query": "<generated_query>",
    "label": "<label>"
  }'

Example request body

JSON

{
  "session_id": "<session_id>",
  "chat_id": "<chat_id>",
  "user_query": "<user_query>",
  "generated_query": "<generated_query>",
  "label": "<label>"
}