{"openapi":"3.1.0","info":{"title":"Cloudflare Vectorize (BYOK) API","version":"0.1.0","description":"Cloudflare Vectorize (BYOK) lets an AI assistant read your own Cloudflare Vectorize data through the Cloudflare Vectorize API with a key you supply (Cloudflare API token with Vectorize read permission). Read-only: 5 tools (list_indexes, get_index, get_index_info, list_vector_ids, list_metadata_indexes). 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-cloudflare-vectorize.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-cloudflare-vectorize/docs"},"termsOfService":"https://connectorbay.com/byok-cloudflare-vectorize/terms"},"servers":[{"url":"https://byok-cloudflare-vectorize.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-cloudflare-vectorize/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_indexes":{"post":{"operationId":"list_indexes","summary":"List the Vectorize indexes of an account with description, dimensions, distance metric and dates. Use for \"Which Vectori","description":"List the Vectorize indexes of an account with description, dimensions, distance metric and dates. Use for \"Which Vectorize indexes do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account_id":{"description":"Cloudflare account id (32-character hex string shown in the dashboard URL, or from the Cloudflare connector's list_accounts).","maxLength":40,"title":"Account Id","type":"string"}},"required":["account_id"],"title":"list_indexesArguments","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_index":{"post":{"operationId":"get_index","summary":"Get one Vectorize index: description, dimensions, distance metric and dates. Use for \"What dimensions and metric does my","description":"Get one Vectorize index: description, dimensions, distance metric and dates. Use for \"What dimensions and metric does my Vectorize index docs-index use\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account_id":{"description":"Cloudflare account id (32-character hex string shown in the dashboard URL, or from the Cloudflare connector's list_accounts).","maxLength":40,"title":"Account Id","type":"string"},"index_name":{"description":"Vectorize index name, as returned by list_indexes.","maxLength":64,"title":"Index Name","type":"string"}},"required":["account_id","index_name"],"title":"get_indexArguments","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_index_info":{"post":{"operationId":"get_index_info","summary":"Get live statistics of a Vectorize index: vector count, dimensions and the last processed mutation time. Use for \"How ma","description":"Get live statistics of a Vectorize index: vector count, dimensions and the last processed mutation time. Use for \"How many vectors are in my Vectorize index\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account_id":{"description":"Cloudflare account id (32-character hex string shown in the dashboard URL, or from the Cloudflare connector's list_accounts).","maxLength":40,"title":"Account Id","type":"string"},"index_name":{"description":"Vectorize index name, as returned by list_indexes.","maxLength":64,"title":"Index Name","type":"string"}},"required":["account_id","index_name"],"title":"get_index_infoArguments","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_vector_ids":{"post":{"operationId":"list_vector_ids","summary":"List the vector ids stored in a Vectorize index (ids only, no vectors or metadata) with a cursor for paging. Use for \"Wh","description":"List the vector ids stored in a Vectorize index (ids only, no vectors or metadata) with a cursor for paging. Use for \"Which vector ids are stored in my index\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account_id":{"description":"Cloudflare account id (32-character hex string shown in the dashboard URL, or from the Cloudflare connector's list_accounts).","maxLength":40,"title":"Account Id","type":"string"},"index_name":{"description":"Vectorize index name, as returned by list_indexes.","maxLength":64,"title":"Index Name","type":"string"},"count":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many ids to return (1 to 1000).","title":"Count"},"cursor":{"anyOf":[{"maxLength":1000,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from the previous answer's nextCursor.","title":"Cursor"}},"required":["account_id","index_name"],"title":"list_vector_idsArguments","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_metadata_indexes":{"post":{"operationId":"list_metadata_indexes","summary":"List the metadata property indexes of a Vectorize index (property name and type) that can be used in query filters. Use ","description":"List the metadata property indexes of a Vectorize index (property name and type) that can be used in query filters. Use for \"Which metadata properties of my Vectorize index can be filtered on\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account_id":{"description":"Cloudflare account id (32-character hex string shown in the dashboard URL, or from the Cloudflare connector's list_accounts).","maxLength":40,"title":"Account Id","type":"string"},"index_name":{"description":"Vectorize index name, as returned by list_indexes.","maxLength":64,"title":"Index Name","type":"string"}},"required":["account_id","index_name"],"title":"list_metadata_indexesArguments","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}}}}