> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# ClickHouse Cloud: Clickhouse Query Endpoint Run Post

> Run a saved ClickHouse query endpoint with complex JSON query variables and get the query results. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

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

> [!NOTE]
>
> 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.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
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

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
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`. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "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.",
    "properties": {
      "queryEndpointId": {
        "type": "string",
        "description": "The unique identifier of the saved Query Endpoint to run.",
        "minLength": 1
      },
      "request_timeout": {
        "type": "integer",
        "description": "Query timeout in milliseconds.",
        "minimum": 1
      },
      "queryVariables": {
        "type": "object",
        "description": "Variables used by the saved query.",
        "additionalProperties": true
      },
      "format": {
        "type": "string",
        "description": "ClickHouse response format, such as JSONEachRow."
      },
      "endpointVersion": {
        "type": "integer",
        "description": "Query Endpoint version sent in the x-clickhouse-endpoint-version header.",
        "default": 2,
        "enum": [
          1,
          2
        ]
      }
    },
    "required": [
      "queryEndpointId"
    ],
    "additionalProperties": false
  }
  ```
</details>

## 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). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "description": "Provider response payload."
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

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

## Related documentation

* [ClickHouse Cloud provider guide](https://deepline.com/docs/providers/clickhouse/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.