{"openapi":"3.1.0","info":{"title":"OpnForm (BYOK) API","version":"0.1.0","description":"OpnForm (BYOK) lets an AI assistant read your own OpnForm data through the OpnForm API with a key you supply (OpnForm personal access token (needs workspaces-read, forms-read, workspace-users-read)). Read-only: 5 tools (list_workspaces, list_workspace_forms, get_form, list_submissions, list_workspace_users). 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-opnform.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-opnform/docs"},"termsOfService":"https://connectorbay.com/byok-opnform/terms"},"servers":[{"url":"https://byok-opnform.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-opnform/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_workspaces":{"post":{"operationId":"list_workspaces","summary":"List the OpnForm workspaces the token's user belongs to. Needs the workspaces-read ability. Use for \"Which OpnForm works","description":"List the OpnForm workspaces the token's user belongs to. Needs the workspaces-read ability. Use for \"Which OpnForm workspaces do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_workspacesArguments","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_workspace_forms":{"post":{"operationId":"list_workspace_forms","summary":"List forms of a workspace as summaries (slug, title, visibility, views and submission counts); no field definitions. Nee","description":"List forms of a workspace as summaries (slug, title, visibility, views and submission counts); no field definitions. Needs forms-read. Use for \"Which forms are in OpnForm workspace 1 and how many submissions do they have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Numeric OpnForm workspace id (from list_workspaces).","title":"Workspace Id","type":"integer"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"Forms per page (1 to 100).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["workspace_id"],"title":"list_workspace_formsArguments","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_form":{"post":{"operationId":"get_form","summary":"Get one OpnForm form by slug or UUID: title, visibility, language, close date, submission limit and the field blocks. Ne","description":"Get one OpnForm form by slug or UUID: title, visibility, language, close date, submission limit and the field blocks. Needs forms-read. Use for \"Show the fields of OpnForm form customer-feedback\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"slug":{"description":"Form slug or UUID, for example 'customer-feedback'.","maxLength":200,"title":"Slug","type":"string"}},"required":["slug"],"title":"get_formArguments","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_submissions":{"post":{"operationId":"list_submissions","summary":"List submissions of an OpnForm form with answers keyed by field id; supports search and completed/partial filter. Needs ","description":"List submissions of an OpnForm form with answers keyed by field id; supports search and completed/partial filter. Needs forms-read. Use for \"Show the latest responses to OpnForm form 42\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"form_id":{"description":"Numeric OpnForm form id (from list_workspace_forms).","title":"Form Id","type":"integer"},"search":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only submissions whose field values match this text.","title":"Search"},"status":{"anyOf":[{"enum":["completed","partial","all"],"type":"string"},{"type":"null"}],"default":"all","description":"Submission status: completed, partial or all.","title":"Status"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"Submissions per page (1 to 100).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["form_id"],"title":"list_submissionsArguments","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_workspace_users":{"post":{"operationId":"list_workspace_users","summary":"List members of an OpnForm workspace with name, email and role. Needs workspace-users-read. Use for \"Who is in OpnForm w","description":"List members of an OpnForm workspace with name, email and role. Needs workspace-users-read. Use for \"Who is in OpnForm workspace 1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Numeric OpnForm workspace id (from list_workspaces).","title":"Workspace Id","type":"integer"}},"required":["workspace_id"],"title":"list_workspace_usersArguments","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}}}}