Example questions

Question and SQL pairs the agent learns 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

Get All Few Shot Examples For Db

GET/v1/agents/{agent_id}/databases/{db_id}/few-shot-examples

Get all few-shot examples 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/few-shot-examples",
    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/few-shot-examples`, {
  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/few-shot-examples" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY"

Create Few Shot Examples For Db

POST/v1/agents/{agent_id}/databases/{db_id}/few-shot-examples

Upload/Create few-shot examples for an agent scoped to a specific database (bulk)

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 · multipart/form-data (optional)

Name	Type	Description
`file`	`string \| null`
`few_shot_examples`	`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.post(
    f"{API_ROOT}/v1/agents/YOUR_AGENT_ID/databases/YOUR_DB_ID/few-shot-examples",
    headers={"X-API-Key": API_KEY},
    data={"file": "<file>", "few_shot_examples": "<few_shot_examples>"},
    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>");
form.append("few_shot_examples", "<few_shot_examples>");

const res = await fetch(`${API_ROOT}/v1/agents/YOUR_AGENT_ID/databases/YOUR_DB_ID/few-shot-examples`, {
  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/YOUR_DB_ID/few-shot-examples" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY" \
  -F "file=<file>" \
  -F "few_shot_examples=<few_shot_examples>"

Update Few Shot Examples For Db

PUT/v1/agents/{agent_id}/databases/{db_id}/few-shot-examples

Update few-shot examples for an agent scoped to a specific database (bulk)

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 · multipart/form-data (optional)

Name	Type	Description
`file`	`string \| null`
`few_shot_examples`	`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.put(
    f"{API_ROOT}/v1/agents/YOUR_AGENT_ID/databases/YOUR_DB_ID/few-shot-examples",
    headers={"X-API-Key": API_KEY},
    data={"file": "<file>", "few_shot_examples": "<few_shot_examples>"},
    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>");
form.append("few_shot_examples", "<few_shot_examples>");

const res = await fetch(`${API_ROOT}/v1/agents/YOUR_AGENT_ID/databases/YOUR_DB_ID/few-shot-examples`, {
  method: "PUT",
  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 PUT "https://futuresmart.ai/database-agent/api/v1/agents/YOUR_AGENT_ID/databases/YOUR_DB_ID/few-shot-examples" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY" \
  -F "file=<file>" \
  -F "few_shot_examples=<few_shot_examples>"

Delete Few Shot Examples For Db

DELETE/v1/agents/{agent_id}/databases/{db_id}/few-shot-examples

Delete few-shot examples for an agent scoped to a specific database.

One or many: {"nl_queries": ["...", "..."]}
All: {"delete_all": true}

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
`nl_queries`	`array<string> \| null`	Natural-language queries of the examples to delete
`delete_all`	`boolean`	Delete ALL few-shot examples for this databaseDefault: false

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/few-shot-examples",
    headers={"X-API-Key": API_KEY},
    json={
        "delete_all": 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/few-shot-examples`, {
  method: "DELETE",
  headers: { "X-API-Key": process.env.DATABASE_AGENT_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({
    "delete_all": false
  }),
});
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/few-shot-examples" \
  -H "X-API-Key: $DATABASE_AGENT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "delete_all": false
  }'

Example request body

JSON

{
  "delete_all": false
}