{"openapi":"3.1.0","info":{"title":"Revel Menu Setup (BYOK) API","version":"0.1.0","description":"Revel Menu Setup (BYOK) lets an AI assistant read your own Revel Menu Setup data through the Revel Menu Setup API with a key you supply (Revel API key and secret joined with a colon (KEY:SECRET)). Read-only: 8 tools (list_modifiers, list_modifier_classes, list_service_fees, list_surcharges, list_price_tiers, list_custom_menus, list_combo_sets, list_inventory_units). The BYOK key travels with each...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-revel-menu-config.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-revel-menu-config/docs"},"termsOfService":"https://connectorbay.com/byok-revel-menu-config/terms"},"servers":[{"url":"https://byok-revel-menu-config.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-revel-menu-config/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_modifiers":{"post":{"operationId":"list_modifiers","summary":"List modifiers (add-ons such as extra cheese) with price, cost, SKU, class and flags. Printer and substitution lists are","description":"List modifiers (add-ons such as extra cheese) with price, cost, SKU, class and flags. Printer and substitution lists are left out. Use for \"What modifiers are available in my Revel menu\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your Revel account subdomain, the part before .revelup.com (for example 'mybistro'). Lowercase letters, digits and hyphens.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"},"establishment":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only objects of this establishment (location) id.","title":"Establishment"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to return only active objects.","title":"Active"},"modifier_class":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only modifiers of this ModifierClass id.","title":"Modifier Class"},"id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only the modifier with this id.","title":"Id"},"limit":{"anyOf":[{"maximum":99,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many objects to return (Revel asks for fewer than 100; default 20).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Number of objects to skip, to page through results.","title":"Offset"},"order_by":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Field to order by, for example id or -id (newest first).","title":"Order By"}},"required":["subdomain"],"title":"list_modifiersArguments","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_modifier_classes":{"post":{"operationId":"list_modifier_classes","summary":"List modifier classes (groups of modifiers such as Toppings) with how many are free and sort order. Use for \"What modifi","description":"List modifier classes (groups of modifiers such as Toppings) with how many are free and sort order. Use for \"What modifier classes does my Revel menu have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your Revel account subdomain, the part before .revelup.com (for example 'mybistro'). Lowercase letters, digits and hyphens.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"},"establishment":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only objects of this establishment (location) id.","title":"Establishment"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to return only active objects.","title":"Active"},"limit":{"anyOf":[{"maximum":99,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many objects to return (Revel asks for fewer than 100; default 20).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Number of objects to skip, to page through results.","title":"Offset"},"order_by":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Field to order by, for example id or -id (newest first).","title":"Order By"}},"required":["subdomain"],"title":"list_modifier_classesArguments","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_service_fees":{"post":{"operationId":"list_service_fees","summary":"List service fees (such as delivery or gratuity charges) with name, amount, tax flag and thresholds. Use for \"What servi","description":"List service fees (such as delivery or gratuity charges) with name, amount, tax flag and thresholds. Use for \"What service fees are configured in Revel\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your Revel account subdomain, the part before .revelup.com (for example 'mybistro'). Lowercase letters, digits and hyphens.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"},"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only service fees with exactly this name.","title":"Name"},"limit":{"anyOf":[{"maximum":99,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many objects to return (Revel asks for fewer than 100; default 20).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Number of objects to skip, to page through results.","title":"Offset"},"order_by":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Field to order by, for example id or -id (newest first).","title":"Order By"}},"required":["subdomain"],"title":"list_service_feesArguments","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_surcharges":{"post":{"operationId":"list_surcharges","summary":"List surcharges with name and active flag. Use for \"What surcharges does my Revel account define\".","description":"List surcharges with name and active flag. Use for \"What surcharges does my Revel account define\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your Revel account subdomain, the part before .revelup.com (for example 'mybistro'). Lowercase letters, digits and hyphens.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"},"limit":{"anyOf":[{"maximum":99,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many objects to return (Revel asks for fewer than 100; default 20).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Number of objects to skip, to page through results.","title":"Offset"},"order_by":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Field to order by, for example id or -id (newest first).","title":"Order By"}},"required":["subdomain"],"title":"list_surchargesArguments","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_price_tiers":{"post":{"operationId":"list_price_tiers","summary":"List price tiers (alternate price lists such as happy hour) with sort order and whether they are admin-only. Use for \"Wh","description":"List price tiers (alternate price lists such as happy hour) with sort order and whether they are admin-only. Use for \"What price tiers are set up in Revel\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your Revel account subdomain, the part before .revelup.com (for example 'mybistro'). Lowercase letters, digits and hyphens.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"},"limit":{"anyOf":[{"maximum":99,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many objects to return (Revel asks for fewer than 100; default 20).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Number of objects to skip, to page through results.","title":"Offset"},"order_by":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Field to order by, for example id or -id (newest first).","title":"Order By"}},"required":["subdomain"],"title":"list_price_tiersArguments","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_custom_menus":{"post":{"operationId":"list_custom_menus","summary":"List custom menus (menu variants by station or time) with mode, application type, price tier and active flag. Use for \"W","description":"List custom menus (menu variants by station or time) with mode, application type, price tier and active flag. Use for \"Which custom menus are active in my Revel account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your Revel account subdomain, the part before .revelup.com (for example 'mybistro'). Lowercase letters, digits and hyphens.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to return only active custom menus.","title":"Active"},"product_group":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only custom menus linked to this ProductGroup id.","title":"Product Group"},"limit":{"anyOf":[{"maximum":99,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many objects to return (Revel asks for fewer than 100; default 20).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Number of objects to skip, to page through results.","title":"Offset"},"order_by":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Field to order by, for example id or -id (newest first).","title":"Order By"}},"required":["subdomain"],"title":"list_custom_menusArguments","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_combo_sets":{"post":{"operationId":"list_combo_sets","summary":"List combo product sets with name, type, price, quantity and the products offered in each set. Use for \"What combo sets ","description":"List combo product sets with name, type, price, quantity and the products offered in each set. Use for \"What combo sets are configured in my Revel menu\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your Revel account subdomain, the part before .revelup.com (for example 'mybistro'). Lowercase letters, digits and hyphens.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"},"product":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only combo sets linked to this Product id.","title":"Product"},"limit":{"anyOf":[{"maximum":99,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many objects to return (Revel asks for fewer than 100; default 20).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Number of objects to skip, to page through results.","title":"Offset"},"order_by":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Field to order by, for example id or -id (newest first).","title":"Order By"}},"required":["subdomain"],"title":"list_combo_setsArguments","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_inventory_units":{"post":{"operationId":"list_inventory_units","summary":"List the units of measure used for ingredient inventory (such as kg or each) with default flag. Use for \"What inventory ","description":"List the units of measure used for ingredient inventory (such as kg or each) with default flag. Use for \"What inventory units does my Revel account use\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your Revel account subdomain, the part before .revelup.com (for example 'mybistro'). Lowercase letters, digits and hyphens.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"},"name":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only the unit with exactly this name.","title":"Name"},"limit":{"anyOf":[{"maximum":99,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many objects to return (Revel asks for fewer than 100; default 20).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Number of objects to skip, to page through results.","title":"Offset"},"order_by":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Field to order by, for example id or -id (newest first).","title":"Order By"}},"required":["subdomain"],"title":"list_inventory_unitsArguments","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}}}}