{"openapi":"3.1.0","info":{"title":"Confluent Cloud Connect (BYOK) API","version":"0.1.0","description":"Confluent Cloud Connect (BYOK) lets an AI assistant read your own Confluent Cloud Connect data through the Confluent Cloud Connect API with a key you supply (Cloud API key ID). Read-only: 8 tools (list_connectors, get_connector_status, get_connector, list_connector_plugins, list_custom_connector_plugins, list_custom_connector_runtimes, list_custom_connect_plugins,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-confluent-cloud-connect.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-confluent-cloud-connect/docs"},"termsOfService":"https://connectorbay.com/byok-confluent-cloud-connect/terms"},"servers":[{"url":"https://byok-confluent-cloud-connect.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-confluent-cloud-connect/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_connectors":{"post":{"operationId":"list_connectors","summary":"List the names of the managed connectors of one Kafka cluster. Use for \"Which connectors run on Confluent Cloud Kafka cl","description":"List the names of the managed connectors of one Kafka cluster. Use for \"Which connectors run on Confluent Cloud Kafka cluster lkc-abc12\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"environment_id":{"description":"Environment id (starts with env-), for example 'env-abc123'.","maxLength":200,"title":"Environment Id","type":"string"},"kafka_cluster_id":{"description":"Kafka cluster id (starts with lkc-), for example 'lkc-abc12'.","maxLength":200,"title":"Kafka Cluster Id","type":"string"}},"required":["environment_id","kafka_cluster_id"],"title":"list_connectorsArguments","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_connector_status":{"post":{"operationId":"get_connector_status","summary":"Get the state of one managed connector and its tasks: connector state, worker, error trace, and per-task state and messa","description":"Get the state of one managed connector and its tasks: connector state, worker, error trace, and per-task state and message. Use for \"Is the Confluent Cloud connector orders-s3-sink running\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"environment_id":{"description":"Environment id (starts with env-), for example 'env-abc123'.","maxLength":200,"title":"Environment Id","type":"string"},"kafka_cluster_id":{"description":"Kafka cluster id (starts with lkc-), for example 'lkc-abc12'.","maxLength":200,"title":"Kafka Cluster Id","type":"string"},"connector_name":{"description":"Name of the managed connector.","maxLength":200,"title":"Connector Name","type":"string"}},"required":["environment_id","kafka_cluster_id","connector_name"],"title":"get_connector_statusArguments","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_connector":{"post":{"operationId":"get_connector","summary":"Get one managed connector's name, type and task list. The connector configuration is not returned. Use for \"What type of","description":"Get one managed connector's name, type and task list. The connector configuration is not returned. Use for \"What type of connector is orders-s3-sink and how many tasks does it have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"environment_id":{"description":"Environment id (starts with env-), for example 'env-abc123'.","maxLength":200,"title":"Environment Id","type":"string"},"kafka_cluster_id":{"description":"Kafka cluster id (starts with lkc-), for example 'lkc-abc12'.","maxLength":200,"title":"Kafka Cluster Id","type":"string"},"connector_name":{"description":"Name of the managed connector.","maxLength":200,"title":"Connector Name","type":"string"}},"required":["environment_id","kafka_cluster_id","connector_name"],"title":"get_connectorArguments","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_connector_plugins":{"post":{"operationId":"list_connector_plugins","summary":"List the managed connector plugins (connector classes, type and version) available on one Kafka cluster. Use for \"Which ","description":"List the managed connector plugins (connector classes, type and version) available on one Kafka cluster. Use for \"Which managed connector plugins can I use on Confluent Cloud cluster lkc-abc12\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"environment_id":{"description":"Environment id (starts with env-), for example 'env-abc123'.","maxLength":200,"title":"Environment Id","type":"string"},"kafka_cluster_id":{"description":"Kafka cluster id (starts with lkc-), for example 'lkc-abc12'.","maxLength":200,"title":"Kafka Cluster Id","type":"string"}},"required":["environment_id","kafka_cluster_id"],"title":"list_connector_pluginsArguments","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_custom_connector_plugins":{"post":{"operationId":"list_custom_connector_plugins","summary":"List custom connector plugins (uploaded by your organization) with name, connector class, type, cloud and runtime langua","description":"List custom connector plugins (uploaded by your organization) with name, connector class, type, cloud and runtime language. Use for \"Which custom connector plugins has our organization uploaded to Confluent Cloud\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"cloud":{"anyOf":[{"enum":["AWS","GCP","AZURE"],"type":"string"},{"type":"null"}],"default":null,"description":"Only plugins for this cloud.","title":"Cloud"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (1 to 100, default 10).","title":"Page Size"},"page_token":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Opaque token from metadata.next of the previous answer, to get the next page.","title":"Page Token"}},"title":"list_custom_connector_pluginsArguments","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_custom_connector_runtimes":{"post":{"operationId":"list_custom_connector_runtimes","summary":"List the runtimes custom connectors can run on with Kafka Connect version, supported Java versions, maturity and end-of-","description":"List the runtimes custom connectors can run on with Kafka Connect version, supported Java versions, maturity and end-of-life date. Use for \"Which runtimes can custom connectors use on Confluent Cloud\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (1 to 100, default 10).","title":"Page Size"},"page_token":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Opaque token from metadata.next of the previous answer, to get the next page.","title":"Page Token"}},"title":"list_custom_connector_runtimesArguments","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_custom_connect_plugins":{"post":{"operationId":"list_custom_connect_plugins","summary":"List custom Connect plugins of one environment (plugin management API) with name, cloud, runtime language and descriptio","description":"List custom Connect plugins of one environment (plugin management API) with name, cloud, runtime language and description. Use for \"Which custom Connect plugins exist in Confluent Cloud environment env-abc123\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"environment":{"description":"Environment id (starts with env-), for example 'env-abc123'.","maxLength":200,"title":"Environment","type":"string"},"cloud":{"anyOf":[{"enum":["AWS","GCP","AZURE"],"type":"string"},{"type":"null"}],"default":null,"description":"Only plugins for this cloud.","title":"Cloud"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (1 to 100, default 10).","title":"Page Size"},"page_token":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Opaque token from metadata.next of the previous answer, to get the next page.","title":"Page Token"}},"required":["environment"],"title":"list_custom_connect_pluginsArguments","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_custom_connect_plugin_versions":{"post":{"operationId":"list_custom_connect_plugin_versions","summary":"List the versions of one custom Connect plugin with version, connector classes, phase and any error. Use for \"Which vers","description":"List the versions of one custom Connect plugin with version, connector classes, phase and any error. Use for \"Which versions of custom Connect plugin ccpm-abc exist\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"plugin_id":{"description":"Id of the custom Connect plugin.","maxLength":200,"title":"Plugin Id","type":"string"},"environment":{"description":"Environment id (starts with env-), for example 'env-abc123'.","maxLength":200,"title":"Environment","type":"string"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (1 to 100, default 10).","title":"Page Size"},"page_token":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Opaque token from metadata.next of the previous answer, to get the next page.","title":"Page Token"}},"required":["plugin_id","environment"],"title":"list_custom_connect_plugin_versionsArguments","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}}}}