v10

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-0643140398.0 KB
Tools

Tabular Data Analysis

Analyze structured tabular data using a natural language query.

post/v1/tools/tabular-data-analysis

Request body

querystring required

The analysis question or prompt related to tabular data.

Example request

{
  "query": "Show average revenue by department over the last 3 quarters.",
  "context_filter": {
    "collection": "collection_name",
    "artifacts": [
      "artifact_id_1, artifact_id_2"
    ],
    "metadata_filter": [
      {
        "key": "file_id",
        "operator": "==",
        "value": "artifact_id_1"
      }
    ]
  }
}

Response

Tabular analysis completed successfully.

is_errorboolean

True if the tool encountered an error during execution.

Example response

{
  "content": [
    {
      "text": "The analysis shows that Q4 revenue increased by 25% compared to Q3.",
      "type": "text"
    }
  ],
  "is_error": false
}