{"openapi":"3.1.0","info":{"title":"Clickhouse Cloud (BYOK) API","version":"0.1.0","description":"Clickhouse Cloud (BYOK) lets an AI assistant read your own Clickhouse Cloud data through the Clickhouse Cloud API with a key you supply (API key ID). Read-only: 10 tools (list_organizations, get_organization, list_services, get_service, list_service_backups, get_backup_configuration, list_clickpipes, list_activities, get_usage_cost, get_quotas). The BYOK key travels with each request, is used for...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-clickhouse-cloud.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-clickhouse-cloud/docs"},"termsOfService":"https://connectorbay.com/byok-clickhouse-cloud/terms"},"servers":[{"url":"https://byok-clickhouse-cloud.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-clickhouse-cloud/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_organizations":{"post":{"operationId":"list_organizations","summary":"List the ClickHouse Cloud organization the API key belongs to, with its ID, name and creation date. Use for \"Which Click","description":"List the ClickHouse Cloud organization the API key belongs to, with its ID, name and creation date. Use for \"Which ClickHouse Cloud organization is my key for\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":250,"minimum":1,"type":"integer"},{"type":"null"}],"default":250,"description":"How many organizations to return (minimum 1, default 250).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from the previous answer's nextCursor to fetch the next page.","title":"Cursor"}},"title":"list_organizationsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_organization":{"post":{"operationId":"get_organization","summary":"Get one ClickHouse Cloud organization: name, creation date, private endpoints and BYOC settings. Use for \"Show the detai","description":"Get one ClickHouse Cloud organization: name, creation date, private endpoints and BYOC settings. Use for \"Show the details of my ClickHouse Cloud organization\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"ClickHouse Cloud organization ID (UUID); list_organizations returns it.","maxLength":200,"title":"Organization Id","type":"string"}},"required":["organization_id"],"title":"get_organizationArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_services":{"post":{"operationId":"list_services","summary":"List the ClickHouse services of an organization with provider, region, state, tier, version and replica counts. Use for ","description":"List the ClickHouse services of an organization with provider, region, state, tier, version and replica counts. Use for \"What ClickHouse Cloud services do I have and are they running\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"ClickHouse Cloud organization ID (UUID); list_organizations returns it.","maxLength":200,"title":"Organization Id","type":"string"}},"required":["organization_id"],"title":"list_servicesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_service":{"post":{"operationId":"get_service","summary":"Get one ClickHouse service: state, endpoints, tier, version, replica and memory scaling limits, idling and release chann","description":"Get one ClickHouse service: state, endpoints, tier, version, replica and memory scaling limits, idling and release channel. Use for \"What are the connection endpoints and scaling limits of my ClickHouse service\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"ClickHouse Cloud organization ID (UUID); list_organizations returns it.","maxLength":200,"title":"Organization Id","type":"string"},"service_id":{"description":"ClickHouse Cloud service ID (UUID); list_services returns it.","maxLength":200,"title":"Service Id","type":"string"}},"required":["organization_id","service_id"],"title":"get_serviceArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_service_backups":{"post":{"operationId":"list_service_backups","summary":"List backups of a ClickHouse service with status, type, size, duration and start and finish times. Use for \"When was my ","description":"List backups of a ClickHouse service with status, type, size, duration and start and finish times. Use for \"When was my ClickHouse service last backed up\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"ClickHouse Cloud organization ID (UUID); list_organizations returns it.","maxLength":200,"title":"Organization Id","type":"string"},"service_id":{"description":"ClickHouse Cloud service ID (UUID); list_services returns it.","maxLength":200,"title":"Service Id","type":"string"}},"required":["organization_id","service_id"],"title":"list_service_backupsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_backup_configuration":{"post":{"operationId":"get_backup_configuration","summary":"Get how often a ClickHouse service is backed up, how long backups are kept and the daily start time. Use for \"What is th","description":"Get how often a ClickHouse service is backed up, how long backups are kept and the daily start time. Use for \"What is the backup schedule and retention of my ClickHouse service\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"ClickHouse Cloud organization ID (UUID); list_organizations returns it.","maxLength":200,"title":"Organization Id","type":"string"},"service_id":{"description":"ClickHouse Cloud service ID (UUID); list_services returns it.","maxLength":200,"title":"Service Id","type":"string"}},"required":["organization_id","service_id"],"title":"get_backup_configurationArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_clickpipes":{"post":{"operationId":"list_clickpipes","summary":"List the ClickPipes (managed ingestion pipelines) of a service with state, scaling and destination table. Use for \"Which","description":"List the ClickPipes (managed ingestion pipelines) of a service with state, scaling and destination table. Use for \"Which ClickPipes feed my ClickHouse service and are they healthy\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"ClickHouse Cloud organization ID (UUID); list_organizations returns it.","maxLength":200,"title":"Organization Id","type":"string"},"service_id":{"description":"ClickHouse Cloud service ID (UUID); list_services returns it.","maxLength":200,"title":"Service Id","type":"string"}},"required":["organization_id","service_id"],"title":"list_clickpipesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_activities":{"post":{"operationId":"list_activities","summary":"List the organization's audit activity log (logins, key changes, service starts and stops) with type, actor type and tim","description":"List the organization's audit activity log (logins, key changes, service starts and stops) with type, actor type and time, optionally within a date range. Use for \"What changed in my ClickHouse Cloud organization recently\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"ClickHouse Cloud organization ID (UUID); list_organizations returns it.","maxLength":200,"title":"Organization Id","type":"string"},"from_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Start of the range as an ISO 8601 date-time, for example 2026-10-01T00:00:00Z.","title":"From Date"},"to_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"End of the range as an ISO 8601 date-time.","title":"To Date"}},"required":["organization_id"],"title":"list_activitiesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_usage_cost":{"post":{"operationId":"get_usage_cost","summary":"Get the organization's usage cost per day and per service or ClickPipe in ClickHouse Credits, with a grand total, for a ","description":"Get the organization's usage cost per day and per service or ClickPipe in ClickHouse Credits, with a grand total, for a date range of at most 30 days. Use for \"How much did my ClickHouse Cloud usage cost in October\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"ClickHouse Cloud organization ID (UUID); list_organizations returns it.","maxLength":200,"title":"Organization Id","type":"string"},"from_date":{"description":"First day of the report as YYYY-MM-DD.","maxLength":200,"title":"From Date","type":"string"},"to_date":{"description":"Last day (inclusive) as YYYY-MM-DD, at most 30 days after from_date.","maxLength":200,"title":"To Date","type":"string"}},"required":["organization_id","from_date","to_date"],"title":"get_usage_costArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_quotas":{"post":{"operationId":"get_quotas","summary":"List the organization's resource quotas (services, replicas, API keys) with the limit and current usage. Use for \"How cl","description":"List the organization's resource quotas (services, replicas, API keys) with the limit and current usage. Use for \"How close am I to my ClickHouse Cloud service limits\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"ClickHouse Cloud organization ID (UUID); list_organizations returns it.","maxLength":200,"title":"Organization Id","type":"string"}},"required":["organization_id"],"title":"get_quotasArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}