{"openapi":"3.1.0","info":{"title":"Zilliz Cloud (BYOK) API","version":"0.1.0","description":"Zilliz Cloud (BYOK) lets an AI assistant read your own Zilliz Cloud data through the Zilliz Cloud API with a key you supply (Zilliz Cloud API key). Read-only: 8 tools (list_clusters, describe_cluster, list_projects, describe_project, list_cloud_providers, list_cloud_regions, list_backups, list_invoices). The BYOK key travels with each request, is used for that one call only and is never stored,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-zilliz.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-zilliz/docs"},"termsOfService":"https://connectorbay.com/byok-zilliz/terms"},"servers":[{"url":"https://byok-zilliz.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-zilliz/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_clusters":{"post":{"operationId":"list_clusters","summary":"List the Zilliz Cloud clusters the API key can see: id, name, region, plan, status, endpoint and creation time. Optional","description":"List the Zilliz Cloud clusters the API key can see: id, name, region, plan, status, endpoint and creation time. Optionally only one cloud region. Use for \"Which Zilliz Cloud clusters do I have\".","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 records to return per page (1 to 100).","title":"Page Size"},"current_page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Current Page"},"region_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only clusters in this cloud region, for example aws-us-west-2.","title":"Region Id"}},"title":"list_clustersArguments","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/describe_cluster":{"post":{"operationId":"describe_cluster","summary":"Get one Zilliz Cloud cluster in detail: plan, status, CU size, replicas, storage, endpoint, creation progress and time. ","description":"Get one Zilliz Cloud cluster in detail: plan, status, CU size, replicas, storage, endpoint, creation progress and time. Use for \"How is my Zilliz cluster in01-108240180a4faf8 doing\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"cluster_id":{"description":"Cluster id, for example in01-108240180a4faf8.","maxLength":60,"title":"Cluster Id","type":"string"}},"required":["cluster_id"],"title":"describe_clusterArguments","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_projects":{"post":{"operationId":"list_projects","summary":"List the Zilliz Cloud projects the API key can see with id, name, plan, regions and cluster count. Use for \"Which Zilliz","description":"List the Zilliz Cloud projects the API key can see with id, name, plan, regions and cluster count. Use for \"Which Zilliz Cloud projects do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_projectsArguments","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/describe_project":{"post":{"operationId":"describe_project","summary":"Get one Zilliz Cloud project: name, description, plan, regions, cluster count and creation time. Use for \"Describe my Zi","description":"Get one Zilliz Cloud project: name, description, plan, regions, cluster count and creation time. Use for \"Describe my Zilliz Cloud project proj-xxxxxxxxxxxxxxxxxxxxxxx\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Project id, for example proj-xxxxxxxxxxxxxxxxxxxxxxx.","maxLength":60,"title":"Project Id","type":"string"}},"required":["project_id"],"title":"describe_projectArguments","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_cloud_providers":{"post":{"operationId":"list_cloud_providers","summary":"List the cloud providers Zilliz Cloud runs on (for example aws, gcp, azure). Use for \"Which cloud providers does Zilliz ","description":"List the cloud providers Zilliz Cloud runs on (for example aws, gcp, azure). Use for \"Which cloud providers does Zilliz Cloud support\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_cloud_providersArguments","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_cloud_regions":{"post":{"operationId":"list_cloud_regions","summary":"List the Zilliz Cloud regions, optionally only those of one cloud provider. Use for \"Which Zilliz Cloud regions are on A","description":"List the Zilliz Cloud regions, optionally only those of one cloud provider. Use for \"Which Zilliz Cloud regions are on AWS\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"cloud_id":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":null,"description":"Cloud provider id such as aws, gcp or azure (from list_cloud_providers).","title":"Cloud Id"}},"title":"list_cloud_regionsArguments","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_backups":{"post":{"operationId":"list_backups","summary":"List AVAILABLE or CREATING backups of dedicated clusters, filtered by project, cluster, creation method or type, with si","description":"List AVAILABLE or CREATING backups of dedicated clusters, filtered by project, cluster, creation method or type, with size, status and expiry. Use for \"What backups exist for my Zilliz cluster inxx-xxxxxxxxxxxxxx\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only backups of this project.","title":"Project Id"},"cluster_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only backups of this cluster.","title":"Cluster Id"},"creation_method":{"anyOf":[{"enum":["MANUAL","AUTO"],"type":"string"},{"type":"null"}],"default":null,"description":"MANUAL or AUTO.","title":"Creation Method"},"backup_type":{"anyOf":[{"enum":["CLUSTER","COLLECTION"],"type":"string"},{"type":"null"}],"default":null,"description":"CLUSTER or COLLECTION.","title":"Backup Type"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many records to return per page (1 to 100).","title":"Page Size"},"current_page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Current Page"}},"title":"list_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/list_invoices":{"post":{"operationId":"list_invoices","summary":"List the organization's invoices with period, status, currency, total and amount due. The key's user must be an organiza","description":"List the organization's invoices with period, status, currency, total and amount due. The key's user must be an organization owner or billing admin. Use for \"What Zilliz Cloud invoices do I have\".","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 records to return per page (1 to 100).","title":"Page Size"},"current_page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Current Page"}},"title":"list_invoicesArguments","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}}}}