{"openapi":"3.1.0","info":{"title":"Formsort (BYOK) API","version":"0.1.0","description":"Formsort (BYOK) lets an AI assistant read your own Formsort data through the Formsort API with a key you supply (Formsort API key (enterprise plan, from the Studio API Keys tab)). Read-only: 5 tools (list_flows, list_flow_variants, list_flow_environments, list_variant_deployments, list_themes). The BYOK key travels with each request, is used for that one call only and is never stored, logged or...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-formsort.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-formsort/docs"},"termsOfService":"https://connectorbay.com/byok-formsort/terms"},"servers":[{"url":"https://byok-formsort.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-formsort/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_flows":{"post":{"operationId":"list_flows","summary":"List the flows (forms and questionnaires) in the workspace with label and creation time. Requires the enterprise plan. U","description":"List the flows (forms and questionnaires) in the workspace with label and creation time. Requires the enterprise plan. Use for \"Which flows exist in my Formsort workspace\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"Results per page (keep at 100 or less).","title":"Per Page"}},"title":"list_flowsArguments","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_variants":{"post":{"operationId":"list_flow_variants","summary":"List the variants of a flow (alternate versions used for testing) with label and creation time. Use for \"What variants d","description":"List the variants of a flow (alternate versions used for testing) with label and creation time. Use for \"What variants does my Formsort flow intake-form have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"flow_label":{"description":"Label of the flow (its URL-safe name in Formsort), from list_flows.","maxLength":100,"title":"Flow Label","type":"string"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"Results per page (keep at 100 or less).","title":"Per Page"}},"required":["flow_label"],"title":"list_flow_variantsArguments","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_environments":{"post":{"operationId":"list_flow_environments","summary":"List the environments of a flow (for example production and staging) with label and current revision uuid. Use for \"Whic","description":"List the environments of a flow (for example production and staging) with label and current revision uuid. Use for \"Which environments does my Formsort flow intake-form have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"flow_label":{"description":"Label of the flow (its URL-safe name in Formsort), from list_flows.","maxLength":100,"title":"Flow Label","type":"string"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"Results per page (keep at 100 or less).","title":"Per Page"}},"required":["flow_label"],"title":"list_flow_environmentsArguments","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_variant_deployments":{"post":{"operationId":"list_variant_deployments","summary":"List the deployments of one variant of a flow: when each was deployed, its notes, the revision and the environment label","description":"List the deployments of one variant of a flow: when each was deployed, its notes, the revision and the environment label. Use for \"When was my Formsort variant main of flow intake-form last deployed\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"flow_label":{"description":"Label of the flow (its URL-safe name in Formsort), from list_flows.","maxLength":100,"title":"Flow Label","type":"string"},"variant_label":{"description":"Label of the variant, from list_flow_variants.","maxLength":100,"title":"Variant Label","type":"string"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"Results per page (keep at 100 or less).","title":"Per Page"}},"required":["flow_label","variant_label"],"title":"list_variant_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_themes":{"post":{"operationId":"list_themes","summary":"List the themes in the workspace with label and creation and update times. Use for \"What themes does my Formsort workspa","description":"List the themes in the workspace with label and creation and update times. Use for \"What themes does my Formsort workspace have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"Results per page (keep at 100 or less).","title":"Per Page"}},"title":"list_themesArguments","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}}}}