{"openapi":"3.1.0","info":{"title":"Flowise Cloud (BYOK) API","version":"0.1.0","description":"Flowise Cloud (BYOK) lets an AI assistant read your own Flowise Cloud data through the Flowise Cloud API with a key you supply (Flowise API key). Read-only: 8 tools (list_chatflows, get_chatflow, list_assistants, list_custom_tools, get_custom_tool, list_document_stores, get_document_store, list_upsert_history). The BYOK key travels with each request, is used for that one call only and is never...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-flowise.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-flowise/docs"},"termsOfService":"https://connectorbay.com/byok-flowise/terms"},"servers":[{"url":"https://byok-flowise.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-flowise/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_chatflows":{"post":{"operationId":"list_chatflows","summary":"List the workspace's chatflows and agent flows with name, type, category, deployed and public flags and dates (flow defi","description":"List the workspace's chatflows and agent flows with name, type, category, deployed and public flags and dates (flow definitions are not returned). Use for \"Which chatflows do I have in Flowise and which are deployed\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_chatflowsArguments","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_chatflow":{"post":{"operationId":"get_chatflow","summary":"Get one chatflow's name, type, category, deployed and public flags and dates by id (the flow graph is not returned). Use","description":"Get one chatflow's name, type, category, deployed and public flags and dates by id (the flow graph is not returned). Use for \"Show the details of Flowise chatflow cf-1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"chatflow_id":{"description":"Chatflow id (UUID) from list_chatflows.","maxLength":200,"title":"Chatflow Id","type":"string"}},"required":["chatflow_id"],"title":"get_chatflowArguments","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_assistants":{"post":{"operationId":"list_assistants","summary":"List OpenAI-style assistants configured in Flowise with name, description, model, tool types and dates (instructions are","description":"List OpenAI-style assistants configured in Flowise with name, description, model, tool types and dates (instructions are not returned). Use for \"Which assistants are configured in my Flowise workspace\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_assistantsArguments","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_tools":{"post":{"operationId":"list_custom_tools","summary":"List custom tools defined in Flowise with name, description and dates (code and schemas are not returned). Use for \"What","description":"List custom tools defined in Flowise with name, description and dates (code and schemas are not returned). Use for \"What custom tools exist in my Flowise workspace\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_custom_toolsArguments","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_custom_tool":{"post":{"operationId":"get_custom_tool","summary":"Get one custom tool's name, description and dates by id (code and schema are not returned). Use for \"Describe Flowise cu","description":"Get one custom tool's name, description and dates by id (code and schema are not returned). Use for \"Describe Flowise custom tool tool-1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"tool_id":{"description":"Custom tool id (UUID) from list_custom_tools.","maxLength":200,"title":"Tool Id","type":"string"}},"required":["tool_id"],"title":"get_custom_toolArguments","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_document_stores":{"post":{"operationId":"list_document_stores","summary":"List document stores with name, description, status and dates. Use for \"What document stores do I have in Flowise\".","description":"List document stores with name, description, status and dates. Use for \"What document stores do I have in Flowise\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_document_storesArguments","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_document_store":{"post":{"operationId":"get_document_store","summary":"Get one document store's name, description, status and dates by id. Use for \"What is the status of Flowise document stor","description":"Get one document store's name, description, status and dates by id. Use for \"What is the status of Flowise document store ds-1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"store_id":{"description":"Document store id (UUID) from list_document_stores.","maxLength":200,"title":"Store Id","type":"string"}},"required":["store_id"],"title":"get_document_storeArguments","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_upsert_history":{"post":{"operationId":"list_upsert_history","summary":"List the upsert (vector indexing) history of a chatflow with ids and dates, oldest first unless DESC is asked. Use for \"","description":"List the upsert (vector indexing) history of a chatflow with ids and dates, oldest first unless DESC is asked. Use for \"When was Flowise chatflow cf-1 last upserted into its vector store\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"chatflow_id":{"description":"Chatflow id (UUID) from list_chatflows.","maxLength":200,"title":"Chatflow Id","type":"string"},"order":{"anyOf":[{"enum":["ASC","DESC"],"type":"string"},{"type":"null"}],"default":"ASC","description":"Sort order: ASC (default) or DESC.","title":"Order"},"start_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only records from this ISO 8601 time, for example 2026-10-01T00:00:00Z.","title":"Start Date"},"end_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only records until this ISO 8601 time.","title":"End Date"}},"required":["chatflow_id"],"title":"list_upsert_historyArguments","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}}}}