{"openapi":"3.1.0","info":{"title":"Userpilot (BYOK) API","version":"0.1.0","description":"Userpilot (BYOK) lets an AI assistant read your own Userpilot data through the Userpilot API with a key you supply (Userpilot API key). Read-only: 11 tools (list_segments, list_flows, list_banners, list_embeds, list_spotlights, list_surveys, list_checklists, list_resource_center_modules, list_tracked_features_and_events, list_user_properties, list_company_properties). The BYOK key travels with...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-userpilot.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-userpilot/docs"},"termsOfService":"https://connectorbay.com/byok-userpilot/terms"},"servers":[{"url":"https://byok-userpilot.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-userpilot/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_segments":{"post":{"operationId":"list_segments","summary":"List user segments with id, title, usage, category, status and whether they are hidden or protected. Use for \"Which user","description":"List user segments with id, title, usage, category, status and whether they are hidden or protected. Use for \"Which user segments exist in my Userpilot account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"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/list_flows":{"post":{"operationId":"list_flows","summary":"List the in-app flows (experiences) with their ids and titles. Uses the standard Userpilot application host (appex.userp","description":"List the in-app flows (experiences) with their ids and titles. Uses the standard Userpilot application host (appex.userpilot.io); EU or dedicated environments with another host are not supported. Use for \"Which flows exist in Userpilot\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"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_banners":{"post":{"operationId":"list_banners","summary":"List the in-app banners with their ids and titles. Uses the standard Userpilot application host (appex.userpilot.io); EU","description":"List the in-app banners with their ids and titles. Uses the standard Userpilot application host (appex.userpilot.io); EU or dedicated environments with another host are not supported. Use for \"Which banners exist in Userpilot\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"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_embeds":{"post":{"operationId":"list_embeds","summary":"List embedded content (banners and cards) with id, title and type. Uses the standard Userpilot application host (appex.u","description":"List embedded content (banners and cards) with id, title and type. Uses the standard Userpilot application host (appex.userpilot.io); EU or dedicated environments with another host are not supported. Use for \"Which embeds and cards does Userpilot have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_embedsArguments","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_spotlights":{"post":{"operationId":"list_spotlights","summary":"List the spotlights (feature highlights) with their ids and titles. Uses the standard Userpilot application host (appex.","description":"List the spotlights (feature highlights) with their ids and titles. Uses the standard Userpilot application host (appex.userpilot.io); EU or dedicated environments with another host are not supported. Use for \"Which spotlights exist in Userpilot\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_spotlightsArguments","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_surveys":{"post":{"operationId":"list_surveys","summary":"List the surveys with id, title, platform and their question modules. Uses the standard Userpilot application host (appe","description":"List the surveys with id, title, platform and their question modules. Uses the standard Userpilot application host (appex.userpilot.io); EU or dedicated environments with another host are not supported. Use for \"Which surveys are set up in Userpilot and what do they ask\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_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 the checklists (with their tasks) by key and display name. Uses the standard Userpilot application host (appex.user","description":"List the checklists (with their tasks) by key and display name. Uses the standard Userpilot application host (appex.userpilot.io); EU or dedicated environments with another host are not supported. Use for \"Which onboarding checklists does Userpilot have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"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_resource_center_modules":{"post":{"operationId":"list_resource_center_modules","summary":"List the resource center modules by key and display name. Uses the standard Userpilot application host (appex.userpilot.","description":"List the resource center modules by key and display name. Uses the standard Userpilot application host (appex.userpilot.io); EU or dedicated environments with another host are not supported. Use for \"Which resource center modules are configured in Userpilot\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_resource_center_modulesArguments","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_tracked_features_and_events":{"post":{"operationId":"list_tracked_features_and_events","summary":"List the tracked features and events by key and display name. Uses the standard Userpilot application host (appex.userpi","description":"List the tracked features and events by key and display name. Uses the standard Userpilot application host (appex.userpilot.io); EU or dedicated environments with another host are not supported. Use for \"Which features and events does Userpilot track\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_tracked_features_and_eventsArguments","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_user_properties":{"post":{"operationId":"list_user_properties","summary":"List the user properties Userpilot holds, with key, display name, data type and whether they are automatic. Uses the sta","description":"List the user properties Userpilot holds, with key, display name, data type and whether they are automatic. Uses the standard Userpilot application host (appex.userpilot.io); EU or dedicated environments with another host are not supported. Use for \"Which user properties are stored in Userpilot\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_user_propertiesArguments","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_company_properties":{"post":{"operationId":"list_company_properties","summary":"List the company properties Userpilot holds, with key, display name, data type and whether they are automatic. Uses the ","description":"List the company properties Userpilot holds, with key, display name, data type and whether they are automatic. Uses the standard Userpilot application host (appex.userpilot.io); EU or dedicated environments with another host are not supported. Use for \"Which company properties are stored in Userpilot\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_company_propertiesArguments","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}}}}