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>"
  ]
}
'
{
  "data": {
    "success": true,
    "summary": "<string>",
    "tables": [
      {
        "name": "<string>",
        "columns": [
          {
            "name": "<string>",
            "type": "<string>"
          }
        ]
      }
    ],
    "unknown_table_names": [
      "<string>"
    ]
  },
  "meta": {
    "requestId": "<string>",
    "timestamp": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.contraforce.com/llms.txt

Use this file to discover all available pages before exploring further.

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