ClickHouse Cloud: Clickhouse Query Endpoint Run Post

Run a saved ClickHouse query endpoint with complex JSON query variables and get the query results.

Tool ID: clickhouse_query_endpoint_run_post

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'clickhouse_query_endpoint_run_post',
  {
    "queryEndpointId": "query_endpoint_123"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute clickhouse_query_endpoint_run_post --input '{
  "queryEndpointId": "query_endpoint_123"
}' --json

Example response

The static output schema lacks the details for a reliable example. Use deepline describe clickhouse_query_endpoint_run_post --json for the complete live contract.

Input reference

Executes a saved Query Endpoint with complex query variables. This action runs the SQL saved in ClickHouse. It can modify data when that saved endpoint has write permissions.

Name	Type	Required	Default	Details
`payload.queryEndpointId`	`string`	Yes	—	The unique identifier of the saved Query Endpoint to run. Minimum length: 1.
`payload.request_timeout`	`integer`	No	—	Query timeout in milliseconds. Minimum: 1.
`payload.queryVariables`	`object`	No	—	Variables used by the saved query.
`payload.format`	`string`	No	—	ClickHouse response format, such as JSONEachRow.
`payload.endpointVersion`	`1 \| 2`	No	`2`	Query Endpoint version sent in the x-clickhouse-endpoint-version header. Allowed: `1`, `2`.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`unknown`	Yes	—	Provider response payload.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation