Skip to main content
POST
/
api
/
v2
/
workspaces
/
{workspaceId}
/
agent
/
tools
/
kql
/
tables
/
columns
Agent tool get kql table columns
curl --request POST \
  --url https://api.example.com/api/v2/workspaces/{workspaceId}/agent/tools/kql/tables/columns \
  --header 'Content-Type: application/json' \
  --data '
{
  "table_names": [
    "<string>"
  ]
}
'
import requests

url = "https://api.example.com/api/v2/workspaces/{workspaceId}/agent/tools/kql/tables/columns"

payload = { "table_names": ["<string>"] }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({table_names: ['<string>']})
};

fetch('https://api.example.com/api/v2/workspaces/{workspaceId}/agent/tools/kql/tables/columns', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v2/workspaces/{workspaceId}/agent/tools/kql/tables/columns",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'table_names' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/api/v2/workspaces/{workspaceId}/agent/tools/kql/tables/columns"

payload := strings.NewReader("{\n \"table_names\": [\n \"<string>\"\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/api/v2/workspaces/{workspaceId}/agent/tools/kql/tables/columns")
.header("Content-Type", "application/json")
.body("{\n \"table_names\": [\n \"<string>\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v2/workspaces/{workspaceId}/agent/tools/kql/tables/columns")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"table_names\": [\n \"<string>\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "success": true,
    "summary": "<string>",
    "tables": [
      {
        "name": "<string>",
        "columns": [
          {
            "name": "<string>",
            "type": "<string>"
          }
        ]
      }
    ],
    "unknown_table_names": [
      "<string>"
    ]
  },
  "meta": {
    "requestId": "<string>",
    "timestamp": "<string>"
  }
}
{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}
{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}
{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}
{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}
{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}

Path Parameters

workspaceId
string<uuid>
required

Body

application/json

Request DTO for the agent's get-KQL-table-columns tool. Pass the table names the agent wants column metadata for — the response includes per-table column lists and echoes back any names that didn't resolve to a real table.

table_names
null | string[]

Table names to fetch column metadata for. Names from list-kql-tables work as-is. Unknown names are echoed back in unknown_table_names rather than silently dropped, so the agent can recover. Must contain at least one entry.

Response

OK

Standard v2 API response envelope for single-item responses.

data
object

Result of the agent's get-KQL-table-columns tool.

meta
object