{"openapi":"3.1.0","info":{"title":"Pipefy (BYOK) API","version":"0.1.0","description":"Pipefy (BYOK) lets an AI assistant read your own Pipefy data through the Pipefy API with a key you supply (Pipefy personal access token or service account token). Read-only: 7 tools (get_me, list_organizations, get_organization, get_pipe, get_phase, get_table, list_pipe_templates). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-pipefy.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-pipefy/docs"},"termsOfService":"https://connectorbay.com/byok-pipefy/terms"},"servers":[{"url":"https://byok-pipefy.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-pipefy/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_me":{"post":{"operationId":"get_me","summary":"Show the Pipefy user the token belongs to: ID, name, username, time zone and role in the current organization. Use for \"","description":"Show the Pipefy user the token belongs to: ID, name, username, time zone and role in the current organization. Use for \"Which Pipefy user am I connected as\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_meArguments","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_organizations":{"post":{"operationId":"list_organizations","summary":"List the organizations (company accounts) the user belongs to with plan name, member count, pipe count, role and creatio","description":"List the organizations (company accounts) the user belongs to with plan name, member count, pipe count, role and creation time. Use for \"Which Pipefy organizations do I have and what plan are they on\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_organizationsArguments","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_organization":{"post":{"operationId":"get_organization","summary":"Get one organization with the IDs and names of its pipes and its database tables (first 50 tables). Use the IDs with get","description":"Get one organization with the IDs and names of its pipes and its database tables (first 50 tables). Use the IDs with get_pipe and get_table. Use for \"Which pipes and tables are in Pipefy organization 12345\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Organization ID (from list_organizations).","maxLength":40,"title":"Organization Id","type":"string"}},"required":["organization_id"],"title":"get_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/get_pipe":{"post":{"operationId":"get_pipe","summary":"Get one pipe (process board): description, card counts, member count, creation time, its phases, start form fields and l","description":"Get one pipe (process board): description, card counts, member count, creation time, its phases, start form fields and labels. Card contents are not returned. Use for \"Show the phases and start form fields of Pipefy pipe 123456\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"pipe_id":{"description":"Pipe ID (the number in the pipe's URL, also returned by get_organization).","maxLength":40,"title":"Pipe Id","type":"string"}},"required":["pipe_id"],"title":"get_pipeArguments","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_phase":{"post":{"operationId":"get_phase","summary":"Get one phase of a pipe: description, card count, whether it is the final (done) or draft phase, lateness limit, and its","description":"Get one phase of a pipe: description, card count, whether it is the final (done) or draft phase, lateness limit, and its fields (ID and label). Use for \"What fields does Pipefy phase 301234 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"phase_id":{"description":"Phase ID (from get_pipe).","maxLength":40,"title":"Phase Id","type":"string"}},"required":["phase_id"],"title":"get_phaseArguments","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_table":{"post":{"operationId":"get_table","summary":"Get one database table: description, number of records, member count, public flag and its field definitions (ID and labe","description":"Get one database table: description, number of records, member count, public flag and its field definitions (ID and label). Record contents are not returned. Use for \"What columns does Pipefy table ZtEdWh have and how many records\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"table_id":{"description":"Database table ID (a short code such as 'ZtEdWh', from get_organization).","maxLength":40,"title":"Table Id","type":"string"}},"required":["table_id"],"title":"get_tableArguments","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_pipe_templates":{"post":{"operationId":"list_pipe_templates","summary":"List the pipe templates Pipefy offers (ID, name, icon and image), useful to see which processes can be started from a te","description":"List the pipe templates Pipefy offers (ID, name, icon and image), useful to see which processes can be started from a template. Use for \"Which pipe templates does Pipefy offer\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_pipe_templatesArguments","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}}}}