Database Query | PrivateGPT

Run a natural language query against connected SQL databases.

Request body for querying connected SQL databases using natural language. Requires at least one SQL database artifact in the tool context.

querystringRequired

The natural language query to run against connected databases.

artifactslist of objectsRequired

List of SQL database artifacts to query against. At least one artifact of type ‘sql_database’ is required.

Database query completed successfully.

contentlist of objects

List of content blocks generated by the tool. Blocks can include plain text, citations, source attributions, or images.

is_errorbooleanDefaults to false

True if the tool encountered an error during execution.

401

Unauthorized Error

422

Unprocessable Entity Error

$	curl -X POST /v1/tools/database-query \
>	-H "Content-Type: application/json" \
>	-d '{
>	"query": "What were the Q4 revenue trends?",
>	"artifacts": [
>	{
>	"context_filter": {}
>	}
>	]
>	}'

1	{
2	"content": [
3	{
4	"text": "The total revenue for Q4 was $3.5M, with the highest contributions from the Sales department.",
5	"type": "text"
6	}
7	],
8	"is_error": false
9	}