{"openapi":"3.1.0","info":{"title":"LearnUpon (BYOK) API","version":"0.1.0","description":"LearnUpon (BYOK) lets an AI assistant read your own LearnUpon data through the LearnUpon API with a key you supply (LearnUpon API username). Read-only: 6 tools (list_groups, list_learning_paths, list_badges, list_locations, list_certifications, list_portals). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-learnupon.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-learnupon/docs"},"termsOfService":"https://connectorbay.com/byok-learnupon/terms"},"servers":[{"url":"https://byok-learnupon.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-learnupon/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_groups":{"post":{"operationId":"list_groups","summary":"List the groups on the portal (for example Sales or Dublin) with title, description, dates and member count; member name","description":"List the groups on the portal (for example Sales or Dublin) with title, description, dates and member count; member names are not returned. Optionally search by title. Use for \"What groups exist in my LearnUpon portal\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"portal":{"description":"Your LearnUpon portal subdomain: 'acme' for acme.learnupon.com.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Portal","type":"string"},"title":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only groups whose title contains this text (case-insensitive).","title":"Title"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1 (the API returns up to 500 records per page).","title":"Page"}},"required":["portal"],"title":"list_groupsArguments","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_learning_paths":{"post":{"operationId":"list_learning_paths","summary":"List learning paths (curricula of courses) with name, price, status, difficulty and length. Draft paths are excluded unl","description":"List learning paths (curricula of courses) with name, price, status, difficulty and length. Draft paths are excluded unless include_draft is true. Use for \"Which learning paths does my LearnUpon portal offer\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"portal":{"description":"Your LearnUpon portal subdomain: 'acme' for acme.learnupon.com.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Portal","type":"string"},"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only paths whose name contains this text (case-insensitive).","title":"Name"},"include_draft":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to include draft versions as well as published ones.","title":"Include Draft"},"include_courses":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to list the courses inside each path.","title":"Include Courses"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1 (the API returns up to 500 records per page).","title":"Page"}},"required":["portal"],"title":"list_learning_pathsArguments","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_badges":{"post":{"operationId":"list_badges","summary":"List the gamification badges available on the portal with name, points, type and image address. Use for \"Which badges ca","description":"List the gamification badges available on the portal with name, points, type and image address. Use for \"Which badges can learners earn in LearnUpon\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"portal":{"description":"Your LearnUpon portal subdomain: 'acme' for acme.learnupon.com.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Portal","type":"string"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1 (the API returns up to 500 records per page).","title":"Page"}},"required":["portal"],"title":"list_badgesArguments","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_locations":{"post":{"operationId":"list_locations","summary":"List the physical locations defined for in-person Live Learning sessions, with address, time zone and country. Use for \"","description":"List the physical locations defined for in-person Live Learning sessions, with address, time zone and country. Use for \"Which in-person training locations are set up in LearnUpon\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"portal":{"description":"Your LearnUpon portal subdomain: 'acme' for acme.learnupon.com.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Portal","type":"string"}},"required":["portal"],"title":"list_locationsArguments","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_certifications":{"post":{"operationId":"list_certifications","summary":"List the certificates the portal can award for completed courses and learning paths (guid and title). Use for \"Which cer","description":"List the certificates the portal can award for completed courses and learning paths (guid and title). Use for \"Which certificates are available in my LearnUpon portal\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"portal":{"description":"Your LearnUpon portal subdomain: 'acme' for acme.learnupon.com.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Portal","type":"string"}},"required":["portal"],"title":"list_certificationsArguments","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_portals":{"post":{"operationId":"list_portals","summary":"List the portal and its sub-portals with subdomain, member count and licence counts. Optionally search by title. Use for","description":"List the portal and its sub-portals with subdomain, member count and licence counts. Optionally search by title. Use for \"Which sub-portals does my LearnUpon account have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"portal":{"description":"Your LearnUpon portal subdomain: 'acme' for acme.learnupon.com.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Portal","type":"string"},"title":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only portals whose title contains this text (case-insensitive).","title":"Title"}},"required":["portal"],"title":"list_portalsArguments","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}}}}