{"openapi":"3.1.0","info":{"title":"SingleStore (BYOK) API","version":"0.1.0","description":"SingleStore (BYOK) lets an AI assistant read your own SingleStore data through the SingleStore API with a key you supply (Management API key). Read-only: 8 tools (get_current_organization, list_projects, list_clusters, get_cluster, list_regions, list_shared_tier_deployments, list_flow_instances, get_billing_usage). The BYOK key travels with each request, is used for that one call only and is...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-singlestore.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-singlestore/docs"},"termsOfService":"https://connectorbay.com/byok-singlestore/terms"},"servers":[{"url":"https://byok-singlestore.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-singlestore/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/get_current_organization":{"post":{"operationId":"get_current_organization","summary":"Get the SingleStore organization the API key belongs to: ID, name and firewall ranges. Use for \"Which SingleStore organi","description":"Get the SingleStore organization the API key belongs to: ID, name and firewall ranges. Use for \"Which SingleStore organization is my key for\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_current_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_projects":{"post":{"operationId":"list_projects","summary":"List the projects the key can access with ID, name, edition and creation date. Use for \"What SingleStore projects do I h","description":"List the projects the key can access with ID, name, edition and creation date. Use for \"What SingleStore 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/list_clusters":{"post":{"operationId":"list_clusters","summary":"List the clusters the key can access with state, cloud provider, region, size, endpoint and auto-suspend settings; termi","description":"List the clusters the key can access with state, cloud provider, region, size, endpoint and auto-suspend settings; terminated ones are hidden unless asked for. Use for \"What SingleStore clusters do I have and are they running\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"include_terminated":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to include terminated clusters.","title":"Include Terminated"},"project_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only clusters of this project (UUID).","title":"Project 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/get_cluster":{"post":{"operationId":"get_cluster","summary":"Get one SingleStore cluster: state, provider, region, size, endpoint, auto-suspend, multi-AZ and creation, resume and ex","description":"Get one SingleStore cluster: state, provider, region, size, endpoint, auto-suspend, multi-AZ and creation, resume and expiry times. Use for \"Show the state and size of my SingleStore cluster\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"cluster_id":{"description":"Cluster ID (UUID); list_clusters returns it.","maxLength":200,"title":"Cluster Id","type":"string"}},"required":["cluster_id"],"title":"get_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_regions":{"post":{"operationId":"list_regions","summary":"List the regions where SingleStore clusters can be created, with cloud provider and region name. Use for \"In which regio","description":"List the regions where SingleStore clusters can be created, with cloud provider and region name. Use for \"In which regions can I create a SingleStore cluster\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_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_shared_tier_deployments":{"post":{"operationId":"list_shared_tier_deployments","summary":"List Shared Edition (starter) deployments with name, project, database, endpoint and ports. Use for \"Which SingleStore s","description":"List Shared Edition (starter) deployments with name, project, database, endpoint and ports. Use for \"Which SingleStore starter workspaces do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_shared_tier_deploymentsArguments","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_flow_instances":{"post":{"operationId":"list_flow_instances","summary":"List SingleStore Flow (data ingest) instances with name, cluster, database, size, status and creation time. Use for \"Wha","description":"List SingleStore Flow (data ingest) instances with name, cluster, database, size, status and creation time. Use for \"What Flow instances do I have in SingleStore\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"include_terminated":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to include terminated instances.","title":"Include Terminated"}},"title":"list_flow_instancesArguments","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_billing_usage":{"post":{"operationId":"get_billing_usage","summary":"Get compute credit and storage usage of the organization over a time range, grouped by hour, day or month, per resource.","description":"Get compute credit and storage usage of the organization over a time range, grouped by hour, day or month, per resource. Use for \"How many compute credits did my SingleStore organization use this month\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"start_time":{"description":"Start of the interval in UTC ISO 8601, for example 2026-10-01T00:00:00Z.","maxLength":200,"title":"Start Time","type":"string"},"end_time":{"description":"End of the interval in UTC ISO 8601.","maxLength":200,"title":"End Time","type":"string"},"metric":{"anyOf":[{"enum":["ComputeCredit","StorageAvgByte"],"type":"string"},{"type":"null"}],"default":null,"description":"ComputeCredit (compute usage) or StorageAvgByte (average storage bytes); both when omitted.","title":"Metric"},"aggregate_by":{"anyOf":[{"enum":["hour","day","month"],"type":"string"},{"type":"null"}],"default":null,"description":"Grouping: hour (default), day or month.","title":"Aggregate By"}},"required":["start_time","end_time"],"title":"get_billing_usageArguments","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}}}}