{"openapi":"3.1.0","info":{"title":"Appcues (BYOK) API","version":"0.1.0","description":"Appcues (BYOK) lets an AI assistant read your own Appcues data through the Appcues API with a key you supply (Appcues API key). Read-only: 11 tools (list_flows, get_flow, list_flows_v2, list_nps_surveys, list_checklists, list_banners, list_pins, list_launchpads, list_segments, get_segment, list_tags). 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-appcues.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-appcues/docs"},"termsOfService":"https://connectorbay.com/byok-appcues/terms"},"servers":[{"url":"https://byok-appcues.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-appcues/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 Appcues flows of an account with name, published state, display frequency, dates and tag IDs. Use for \"Which Ap","description":"List the Appcues flows of an account with name, published state, display frequency, dates and tag IDs. Use for \"Which Appcues flows are published\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account_id":{"description":"Appcues account ID (a number), shown on your Appcues Studio account settings page.","maxLength":200,"title":"Account Id","type":"string"}},"required":["account_id"],"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/get_flow":{"post":{"operationId":"get_flow","summary":"Get one Appcues flow by ID: name, published state, display frequency, dates and tags. Use for \"Show details of Appcues f","description":"Get one Appcues flow by ID: name, published state, display frequency, dates and tags. Use for \"Show details of Appcues flow flow1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account_id":{"description":"Appcues account ID (a number), shown on your Appcues Studio account settings page.","maxLength":200,"title":"Account Id","type":"string"},"flow_id":{"description":"Appcues flow ID, from list_flows.","maxLength":200,"title":"Flow Id","type":"string"}},"required":["account_id","flow_id"],"title":"get_flowArguments","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_flows_v2":{"post":{"operationId":"list_flows_v2","summary":"List Appcues Flows 2.0 experiences with name, state, platform, display frequency, dates and tags. Use for \"Which Appcues","description":"List Appcues Flows 2.0 experiences with name, state, platform, display frequency, dates and tags. Use for \"Which Appcues Flows 2.0 experiences are in draft\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account_id":{"description":"Appcues account ID (a number), shown on your Appcues Studio account settings page.","maxLength":200,"title":"Account Id","type":"string"}},"required":["account_id"],"title":"list_flows_v2Arguments","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_nps_surveys":{"post":{"operationId":"list_nps_surveys","summary":"List Appcues NPS 2.0 surveys with name, state, platform, display frequency, dates and tags. Use for \"Which NPS surveys a","description":"List Appcues NPS 2.0 surveys with name, state, platform, display frequency, dates and tags. Use for \"Which NPS surveys are set up in Appcues\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account_id":{"description":"Appcues account ID (a number), shown on your Appcues Studio account settings page.","maxLength":200,"title":"Account Id","type":"string"}},"required":["account_id"],"title":"list_nps_surveysArguments","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_checklists":{"post":{"operationId":"list_checklists","summary":"List Appcues checklists with title, state, whether items must be completed in order, publish state and dates. Use for \"W","description":"List Appcues checklists with title, state, whether items must be completed in order, publish state and dates. Use for \"Which onboarding checklists do I have in Appcues\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account_id":{"description":"Appcues account ID (a number), shown on your Appcues Studio account settings page.","maxLength":200,"title":"Account Id","type":"string"}},"required":["account_id"],"title":"list_checklistsArguments","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_banners":{"post":{"operationId":"list_banners","summary":"List Appcues banners with name, state, platform, display frequency, dates and tags. Use for \"Which banners exist in Appc","description":"List Appcues banners with name, state, platform, display frequency, dates and tags. Use for \"Which banners exist in Appcues\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account_id":{"description":"Appcues account ID (a number), shown on your Appcues Studio account settings page.","maxLength":200,"title":"Account Id","type":"string"}},"required":["account_id"],"title":"list_bannersArguments","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_pins":{"post":{"operationId":"list_pins","summary":"List Appcues pins (persistent tooltips) with name, state, platform, display frequency, dates and tags. Use for \"Which pi","description":"List Appcues pins (persistent tooltips) with name, state, platform, display frequency, dates and tags. Use for \"Which pins are live in Appcues\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account_id":{"description":"Appcues account ID (a number), shown on your Appcues Studio account settings page.","maxLength":200,"title":"Account Id","type":"string"}},"required":["account_id"],"title":"list_pinsArguments","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_launchpads":{"post":{"operationId":"list_launchpads","summary":"List Appcues launchpads with name, state, platform, display frequency, dates and tags. Use for \"Which launchpads exist i","description":"List Appcues launchpads with name, state, platform, display frequency, dates and tags. Use for \"Which launchpads exist in Appcues\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account_id":{"description":"Appcues account ID (a number), shown on your Appcues Studio account settings page.","maxLength":200,"title":"Account Id","type":"string"}},"required":["account_id"],"title":"list_launchpadsArguments","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_segments":{"post":{"operationId":"list_segments","summary":"List the user segments of an Appcues account with name, description and dates. Use for \"Which user segments are defined ","description":"List the user segments of an Appcues account with name, description and dates. Use for \"Which user segments are defined in Appcues\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account_id":{"description":"Appcues account ID (a number), shown on your Appcues Studio account settings page.","maxLength":200,"title":"Account Id","type":"string"}},"required":["account_id"],"title":"list_segmentsArguments","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_segment":{"post":{"operationId":"get_segment","summary":"Get one Appcues user segment by ID: name, description and dates. Use for \"Describe Appcues segment -LQA2aYxavNXfyzm9mtP\"","description":"Get one Appcues user segment by ID: name, description and dates. Use for \"Describe Appcues segment -LQA2aYxavNXfyzm9mtP\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account_id":{"description":"Appcues account ID (a number), shown on your Appcues Studio account settings page.","maxLength":200,"title":"Account Id","type":"string"},"segment_id":{"description":"Appcues segment ID, from list_segments.","maxLength":200,"title":"Segment Id","type":"string"}},"required":["account_id","segment_id"],"title":"get_segmentArguments","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_tags":{"post":{"operationId":"list_tags","summary":"List the tags used to group Appcues experiences, with creation and update dates. Use for \"Which tags are used in Appcues","description":"List the tags used to group Appcues experiences, with creation and update dates. Use for \"Which tags are used in Appcues\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account_id":{"description":"Appcues account ID (a number), shown on your Appcues Studio account settings page.","maxLength":200,"title":"Account Id","type":"string"}},"required":["account_id"],"title":"list_tagsArguments","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}}}}