POST
/
v1
/
tools
/
database-query
{
"content": [
{
"type": "text",
"text": "The total revenue for Q4 was $3.5M, with the highest contributions from the Sales department."
}
],
"is_error": false
}

Body

application/json

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

Request body for tabular data analysis using the tool.

query
string
required

The analysis question or prompt related to tabular data.

Examples:

"Show average revenue by department over the last 3 quarters."

context_filter
object
required

Filters to select specific context from ingested documents.

Response

Database query completed successfully.

Response returned from tool-based operations.

content
Content · array
required

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

is_error
boolean
default:false

True if the tool encountered an error during execution.