BrowseWixRESTDocsMenu
Browse the Wix REST API documentation menu hierarchy. Alternative to SearchWixRESTDocumentation - use this to explore and discover APIs by navigating the menu structure instead of searching by keywords.
Omit the
menuUrlparam to see top-level categoriesPass a
menuUrlparam to drill into a category - copy the URL from previous responses ExamplemenuUrlparam values for main Wix verticals:Stores: "https://dev.wix.com/docs/api-reference/business-solutions/stores"
Bookings: "https://dev.wix.com/docs/api-reference/business-solutions/bookings"
CMS: "https://dev.wix.com/docs/api-reference/business-solutions/cms"
eCommerce: "https://dev.wix.com/docs/api-reference/business-solutions/e-commerce"
Events: "https://dev.wix.com/docs/api-reference/business-solutions/events"
Blog: "https://dev.wix.com/docs/api-reference/business-solutions/blog"
Pricing Plans: "https://dev.wix.com/docs/api-reference/business-solutions/pricing-plans"
Restaurants: "https://dev.wix.com/docs/api-reference/business-solutions/restaurants"
Media: "https://dev.wix.com/docs/api-reference/assets/media"
Site Properties: "https://dev.wix.com/docs/api-reference/business-management/site-properties"
RECIPE BASED (PREFERRED!): WixREADME() -> find relevant recipe for the user's prompt/task -> read recipe using ReadFullDocsArticle() -> call Wix API using CallWixSiteAPI() based on the recipe
CONVERSATION CONTEXT BASED: find relevant docs article or API example for the user's prompt/task in the conversation context -> call API using CallWixSiteAPI() based on the docs article or API example
EXAMPLE BASED: WixREADME() -> no relevant recipe found for user's prompt/task -> BrowseWixRESTDocsMenu() or SearchWixRESTDocumentation() -> find relevant method -> read method article using ReadFullDocsArticle() to get method code examples -> call API using CallWixSiteAPI() based on the method code examples
SCHEMA BASED, FALLBACK: WixREADME() -> no relevant recipe found for user's prompt/task -> BrowseWixRESTDocsMenu() or SearchWixRESTDocumentation() -> find relevant method -> read method article using ReadFullDocsArticle() -> no method code examples found -> inspect the method schema using SearchWixAPISpec or ReadFullDocsMethodSchema -> call API using CallWixSiteAPI() based on the schema Without WixREADME tool:
CONVERSATION CONTEXT BASED: find relevant docs article or API example for the user's prompt/task in the conversation context -> call API using CallWixSiteAPI() based on the docs article or API example
METHOD CODE EXAMPLE BASED: BrowseWixRESTDocsMenu() or SearchWixRESTDocumentation() -> find relevant method -> read method article using ReadFullDocsArticle() to get method code examples -> call API using CallWixSiteAPI() based on the method code examples
FULL SCHEMA BASED: BrowseWixRESTDocsMenu() or SearchWixRESTDocumentation() -> find relevant method -> read method article using ReadFullDocsArticle() -> no method code examples found -> inspect the method schema using SearchWixAPISpec or ReadFullDocsMethodSchema -> call API using CallWixSiteAPI() based on the schema
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| reason | Yes | One sentence describing the original user request and why you are browsing this part of the docs menu. | |
| menuUrl | No | URL of the menu to browse. Empty/omitted returns the root menu. Copy the URL from links in previous responses of this tool. Example: "https://dev.wix.com/docs/api-reference/ecommerce" or "https://dev.wix.com/docs/api-reference/ecommerce/catalog" |