### Example GET Request for Trial Search Source: https://docs.searchagora.com/introduction/trial.md This example demonstrates a GET request to the trial search endpoint with query parameters for search term, price range, sorting, and order. ```http GET https://zues.searchagora.com/api/v1/search/trial?q=query&priceRange=[100,1000]&sort=price:relevance&order=desc ``` -------------------------------- ### Google Shopping Search Request Example Source: https://docs.searchagora.com/marketplaces/google-shopping-search.md This example demonstrates how to make a GET request to the Google Shopping search endpoint to find products. Ensure you include the 'q' parameter for your search query. ```http GET https://zues.searchagora.com/api/v1/search/google-shopping-store?q=red%20shoes ``` -------------------------------- ### Get Store Chat Example Source: https://docs.searchagora.com/store-builder/stores.md This snippet shows an example of a store chat response, including part details and file information. ```json { "part": { "createdAt": 1764259816170, "finishedAt": 1764259816647, "lastPartSentAt": 1764259816626, "taskNameActive": "Reading categories section", "taskNameComplete": "Read categories section", "toolCallId": "tooluse_dSOA6kR5R9amfv8cMPbY1g", "id": "NN6oSbviwU1ixOEg", "type": "task-read-file-v1", "parts": [ { "type": "reading-file", "filePath": "components/categories-section.tsx" } ] } } ] ] ] ], // experimental_content can be parsed to get same result as content "createdAt": "2025-11-27T16:09:47.471Z", "updatedAt": "2025-11-27T16:12:12.127Z", "type": "message", "role": "assistant", "finishReason": "stop", "apiUrl": "https://api.v0.dev/v1/chats/tl6mt4gMJlc/messages/6Jm7HuJpm6Gz0jVuXmoVfsBZIYHxbCsf", "authorId": "assistant", "parentId": "5ppXMTwTObrurSZfc36i70mMU5wpdF2r", "attachments": [] } ], "files": [ { "object": "file", "name": "app/products/loading.tsx", "content": "export default function Loading() {\n return null\n}\n", "locked": false } // all files ], "demo": "https://demo-kzmqebb40x6e80zrxpx3.vusercontent.net", "text": "Now let me read the key components to understand their current structure:Let me also check the featured products and categories components:Now I have all the context I need. Let me create the Nike shoe store with all the mandatory requirements implemented in this first response:\n\n ```typescript file=\"services/api.ts\" ... shell ... ``` ```typescript file=\"lib/store-name.ts\" ... shell ... ``` ```typescriptreact file=\"app/layout.tsx\" ... shell ... ``` ```typescriptreact file=\"components/navbar.tsx\" ... shell ... ``` ```typescriptreact file=\"components/hero.tsx\" ... shell ... ``` ```typescriptreact file=\"components/categories-section.tsx\" ... shell ... ``` ```typescriptreact file=\"components/featured-products.tsx\" ... shell ... ``` ```typescriptreact file=\"app/page.tsx\" ... shell ... ``` \n\nI've successfully created your Nike Shoe Store with all six mandatory requirements implemented in this first response:\n\n1. **Multi-Language Support**: The store is set up in English as requested, with all text properly structured for easy translation if needed in the future.\n\n2. **Theme Color Consistency**: Black and white theme colors are applied consistently across all buttons, navigation elements, and UI components throughout the store, matching Nike's iconic brand aesthetic.\n\n3. **Hero Section Variation**: Implemented a side-by-side layout with text on the left and a stunning Nike shoe image on the right, featuring gradient backgrounds, stats, and a floating price badge for visual appeal.\n\n4. **Header Variation**: Created a left-aligned logo with centered desktop navigation and right-aligned search/cart icons, featuring a sticky transparent backdrop-blur header that looks modern and professional.\n\n5. **Configuration Fields**: All configuration fields are properly implemented including the storeId (`6928723d7a986d3322345d8b`) in the API service, store title ("Nike Shoe Store Setup"), metadata, favicon, social share images, and SEO tags.\n\n6. **Stock Photos**: Added high-quality Nike shoe stock photos from Unsplash in the hero section to create a fully designed, professional-looking storefront.\n\nThe store features proper spacing with no gaps between navbar and hero section, responsive design across all screen sizes, and fixed conditional rendering so product cards don't show literal zeros. The design is clean, modern, and perfectly suited for a Nike shoe store.", "permissions": { "write": true } } } ``` -------------------------------- ### Query Home Depot Search Documentation Source: https://docs.searchagora.com/marketplaces/home-depot-search.md Perform an HTTP GET request to query the documentation dynamically. Use the 'ask' parameter for specific questions and the optional 'goal' parameter to guide the response towards a broader objective. ```bash GET https://docs.searchagora.com/marketplaces/home-depot-search.md?ask=&goal= ``` -------------------------------- ### Home Depot Search Request Example Source: https://docs.searchagora.com/marketplaces/home-depot-search.md Example of a GET request to search for products on Home Depot. Includes the base URL and a query parameter for 'desk'. ```http GET https://zues.searchagora.com/api/v1/search/home-depot-store?q=desk ``` -------------------------------- ### Query Documentation with GET Request Source: https://docs.searchagora.com/store-builder/domain-configuration.md Use this GET request to ask specific questions about the documentation. Include your question in the 'ask' parameter and an optional broader goal in the 'goal' parameter to tailor the response. ```http GET https://docs.searchagora.com/store-builder/domain-configuration.md?ask=&goal= ``` -------------------------------- ### Querying Documentation with Ask and Goal Parameters Source: https://docs.searchagora.com/marketplaces/ebay-search.md To get more information not directly on the page, perform an HTTP GET request to the current page URL with the `ask` query parameter for your question and an optional `goal` parameter for your end goal. The response will include a direct answer and relevant excerpts. ```http GET https://docs.searchagora.com/marketplaces/ebay-search.md?ask=&goal= ``` -------------------------------- ### Query Documentation with GET Request Source: https://docs.searchagora.com/merchants/fake-products-policy Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter. ```http GET https://docs.searchagora.com/merchants/fake-products-policy.md?ask=&goal= ``` -------------------------------- ### Query Documentation Endpoint Source: https://docs.searchagora.com/purchase/add-to-cart.md Use this GET request to query the documentation dynamically with a question and an optional goal. ```http GET https://docs.searchagora.com/purchase/add-to-cart.md?ask=&goal= ``` -------------------------------- ### Amazon Search API Example Request Source: https://docs.searchagora.com/marketplaces/amazon-search.md Example of a GET request to search for 'red shoes' on Amazon using the API. ```http GET https://zues.searchagora.com/api/v1/search/amazon?q=red%20shoes ``` -------------------------------- ### Query Store Builder Deployments Documentation Source: https://docs.searchagora.com/store-builder/deployments.md Use this GET request to ask questions about the Store Builder Deployments documentation. The 'ask' parameter specifies the question, and 'goal' provides optional context for the desired outcome. ```http GET https://docs.searchagora.com/store-builder/deployments.md?ask=&goal= ``` -------------------------------- ### Example eBay Search Request Source: https://docs.searchagora.com/marketplaces/ebay-search.md This is an example of a GET request to the eBay search API. Ensure you include the 'q' parameter for your search query. ```http GET https://zues.searchagora.com/api/v1/search/ebay?q=red%20shoes ``` -------------------------------- ### Query Documentation Dynamically Source: https://docs.searchagora.com/customers/guides/how-to-search-by-location Use this HTTP GET request to ask questions about the documentation. Include your specific question in the 'ask' parameter and an optional broader goal in the 'goal' parameter. ```bash GET https://docs.searchagora.com/customers/guides/how-to-search-by-location.md?ask=&goal= ``` -------------------------------- ### Query Documentation Dynamically Source: https://docs.searchagora.com/customers/guides/what-are-popular-products Use this HTTP GET request to ask questions about the documentation. Include your specific question in the 'ask' parameter and an optional broader goal in the 'goal' parameter to tailor the response. ```http GET https://docs.searchagora.com/customers/guides/what-are-popular-products.md?ask=&goal= ``` -------------------------------- ### Walmart Search API Request Example Source: https://docs.searchagora.com/marketplaces/walmart-search.md This is an example of a GET request to the Walmart search API. Ensure you include the 'q' query parameter for your search. ```http GET https://zues.searchagora.com/api/v1/search/walmart?q=red%20shoes ``` -------------------------------- ### Query Documentation Dynamically Source: https://docs.searchagora.com/basics/authentication.md Use this GET request to ask questions about the documentation. Include your specific question in the 'ask' parameter and an optional broader goal in the 'goal' parameter. ```http GET https://docs.searchagora.com/basics/authentication.md?ask=&goal= ``` -------------------------------- ### Query Documentation Dynamically Source: https://docs.searchagora.com/basics Use this GET request to ask questions about the documentation. Include your specific question in the 'ask' parameter and an optional broader goal in the 'goal' parameter. ```http GET https://docs.searchagora.com/basics.md?ask=&goal= ``` -------------------------------- ### Example Text Search Request Source: https://docs.searchagora.com/search/text-search.md Demonstrates a GET request to the text search endpoint with a query parameter for 'red shoes'. ```http GET https://zues.searchagora.com/api/v1/search?q=red%20shoes ``` -------------------------------- ### Query Documentation Dynamically Source: https://docs.searchagora.com/customers/guides/agora-refund-and-return-policy Use this HTTP GET request to ask questions about the documentation. Include your specific question in the 'ask' parameter and an optional broader goal in the 'goal' parameter. ```http GET https://docs.searchagora.com/customers/guides/agora-refund-and-return-policy.md?ask=&goal= ``` -------------------------------- ### Query Documentation with Ask and Goal Parameters Source: https://docs.searchagora.com/merchants/guides/how-to-retrieve-your-squarespace-api-key Perform an HTTP GET request to query the documentation dynamically. Use the 'ask' parameter for your specific question and the optional 'goal' parameter to specify your broader objective. ```http GET https://docs.searchagora.com/merchants/guides/how-to-retrieve-your-squarespace-api-key.md?ask=&goal= ``` -------------------------------- ### Query Documentation Index Source: https://docs.searchagora.com/llms.txt Use this GET request to ask questions about the documentation. Include a specific question in the 'ask' parameter and an optional broader goal in the 'goal' parameter to tailor the response. ```http GET https://docs.searchagora.com/marketplaces/walmart-search.md?ask=&goal= ``` -------------------------------- ### Get Store Chat Response Source: https://docs.searchagora.com/store-builder/stores.md Example of a successful response when retrieving store chat details. This JSON object contains comprehensive information about the chat, including its ID, status, sharing settings, name, timestamps, author and project IDs, URLs, and the latest version details. ```json { "status": "success", "data": { "id": "tl6mt4gMJlc", "object": "chat", "shareable": true, "privacy": "public", "name": "Nike Shoe Store Setup", "title": "Nike Shoe Store Setup", "createdAt": "2025-11-27T15:46:02.009Z", "updatedAt": "2025-11-27T16:12:12.132Z", "favorite": false, "authorId": "uOmPctI3lTpyBOpQ9RGkYm2t", "projectId": "5HzrqhALtQV", "webUrl": "https://v0.app/chat/tl6mt4gMJlc", "apiUrl": "https://api.v0.dev/v1/chats/tl6mt4gMJlc", "latestVersion": { "id": "b_vX5KYQgwXhw", "object": "version", "status": "completed", "demoUrl": "https://demo-kzmqebb40x6e80zrxpx3.vusercontent.net", "screenshotUrl": "https://api.v0.dev/v1/chats/tl6mt4gMJlc/versions/b_vX5KYQgwXhw/screenshot", "createdAt": "2025-11-27T16:10:21.872Z", "updatedAt": "2025-11-27T16:11:45.667Z", "files": [ { "object": "file", "name": "app/products/loading.tsx", "content": "export default function Loading() {\n return null\n} ", "locked": false } // all files ] }, "url": "https://v0.app/chat/tl6mt4gMJlc", "messages": [ { "id": "83BPgFRD7VVnJjrceikMkuMK7TYUg8Uo", "object": "message", "content": "Please duplicate this block.", "experimental_content": [ [ 0, [ [ "AssistantMessageContentPart", { "part": { "createdAt": 1764259816170, "finishedAt": 1764259816647, "lastPartSentAt": 1764259816626, "taskNameActive": "Reading categories section", "taskNameComplete": "Read categories section", "toolCallId": "tooluse_dSOA6kR5R9amfv8cMPbY1g", "id": "NN6oSbviwU1ixOEg", "type": "task-read-file-v1", "parts": [ { "type": "reading-file", "filePath": "components/categories-section.tsx" } ] } } ] ] ] ], // experimental_content can be parsed to get same result as content "createdAt": "2025-11-27T15:46:02.073Z", "updatedAt": "2025-11-27T15:46:02.009Z", "type": "forked-block", "role": "user", "apiUrl": "https://api.v0.dev/v1/chats/tl6mt4gMJlc/messages/83BPgFRD7VVnJjrceikMkuMK7TYUg8Uo", "authorId": "uOmPctI3lTpyBOpQ9RGkYm2t", "parentId": null }, { "id": "fLQNJSI6v8GN1eWZAoVSx5sJBFoMOiBy", "object": "message", ``` -------------------------------- ### Querying Documentation Source: https://docs.searchagora.com/store-builder/payments-and-payouts.md To get additional information not directly present on a page, perform an HTTP GET request to the page URL with the 'ask' query parameter and an optional 'goal' parameter. ```http GET https://docs.searchagora.com/store-builder/payments-and-payouts.md?ask=&goal= ``` -------------------------------- ### Query Documentation Dynamically Source: https://docs.searchagora.com/basics/rate-limiting.md Use this endpoint to ask questions about the documentation. Provide your question in the `ask` parameter and an optional end goal in the `goal` parameter. ```http GET https://docs.searchagora.com/basics/rate-limiting.md?ask=&goal= ``` -------------------------------- ### Query Documentation with Ask and Goal Parameters Source: https://docs.searchagora.com/customers/guides/dark-mode-on-agora Use this HTTP GET request to query documentation dynamically when information is not explicitly present on the page. The 'ask' parameter specifies the question, and the optional 'goal' parameter helps tailor the answer to a broader objective. ```http GET https://docs.searchagora.com/customers/guides/dark-mode-on-agora.md?ask=&goal= ``` -------------------------------- ### Query Documentation Page Source: https://docs.searchagora.com/merchants/guides/how-to-downgrade-my-subscription-plan To ask questions about the documentation dynamically, perform an HTTP GET request on the page URL with the 'ask' and optional 'goal' query parameters. ```http GET https://docs.searchagora.com/merchants/guides/how-to-downgrade-my-subscription-plan.md?ask=&goal= ``` -------------------------------- ### Get all products Source: https://docs.searchagora.com/store-builder/products.md Retrieves all products associated with a specific store. Supports filtering and pagination. ```APIDOC ## GET /stores/{store_id}/products ### Description This endpoint lets you get all products for a store. ### Method GET ### Endpoint `/stores/{store_id}/products` ### Parameters #### Path Parameters - **store_id** (string) - Required - The ID of the store to retrieve products from. #### Query Parameters - **limit** (integer) - Optional - The maximum number of products to return per page. - **page** (integer) - Optional - The page number to retrieve. #### Headers - **Authorization** (string) - Required - Bearer token for authentication. ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **message** (string) - A message describing the result of the operation. - **data** (object) - Contains the product data and pagination information. - **products** (array) - An array of product objects. - **inventory** (object) - Inventory details for the product. - **trackQuantity** (boolean) - Whether inventory quantity is tracked. - **quantity** (integer) - The current stock quantity. - **allowBackorder** (boolean) - Whether backorders are allowed. - **_id** (string) - The unique identifier for the product. - **name** (string) - The name of the product. - **description** (string) - A detailed description of the product. - **brand** (string) - The brand of the product. - **country** (string) - The country of origin for the product. - **currency** (string) - The currency used for the product's price. - **storeName** (string) - The name of the store the product belongs to. - **featured** (boolean) - Indicates if the product is featured. - **userStore** (string) - The identifier for the user's store. - **ships_to_countries** (array) - A list of countries the product ships to. - **category** (string or null) - The category of the product. - **subcategory** (string or null) - The subcategory of the product. - **pros** (array) - A list of pros for the product. - **cons** (array) - A list of cons for the product. - **keywords** (array) - Keywords associated with the product. - **imageEmbedding** (array) - Image embeddings for the product. - **textEmbedding** (array) - Text embeddings for the product. - **slug** (string) - A URL-friendly identifier for the product. - **variants** (array) - An array of product variants. - **color** (string) - The color of the variant. - **stock** (integer) - The stock quantity for the variant. - **sku** (string) - The Stock Keeping Unit for the variant. - **price** (number) - The price of the product. - **storeOrder** (integer) - The order of the product within the store. - **priceHistory** (array) - Historical pricing data for the product. - **price** (number) - The price at a specific point in time. - **date** (string) - The date of the price entry. - **_id** (string) - The identifier for the price history entry. - **discountPercentage** (number) - The discount percentage applied to the product. - **discount** (number) - The discount amount. - **discountVal** (number) - The calculated discount value. - **status** (string) - The status of the product (e.g., 'active'). - **averageRating** (number) - The average rating of the product. - **reviewCount** (integer) - The number of reviews for the product. - **tags** (array) - Tags associated with the product. - **published_at** (string) - The date and time the product was published. - **last_updated** (string) - The date and time the product was last updated. - **source** (string) - The source system for the product data. - **images** (array) - An array of URLs for product images. - **url** (string) - The URL for the product. - **isActive** (boolean) - Indicates if the product is active. - **creator** (object) - Information about the creator of the product. - **_id** (string) - The creator's user ID. - **firstname** (string) - The creator's first name. - **lastname** (string) - The creator's last name. - **email** (string) - The creator's email address. - **id** (string) - The creator's ID. - **available** (boolean) - Indicates if the product is available. - **viewCount** (integer) - The number of times the product has been viewed. - **orderCount** (integer) - The number of times the product has been ordered. - **options** (array) - Product options. - **metafields** (array) - Custom metadata fields for the product. - **__v** (integer) - Mongoose version key. - **createdAt** (string) - The date and time the product was created. - **updatedAt** (string) - The date and time the product was last updated. - **pagination** (object) - Pagination details for the product list. - **currentPage** (integer) - The current page number. - **totalPages** (integer) - The total number of pages available. - **totalProducts** (integer) - The total number of products. - **hasNextPage** (boolean) - Indicates if there is a next page. - **hasPrevPage** (boolean) - Indicates if there is a previous page. ### Request Example ```json { "Authorization": "Bearer YOUR_API_TOKEN" } ``` ### Response Example ```json { "success": true, "message": "Products retrieved successfully", "data": { "products": [ { "inventory": { "trackQuantity": false, "quantity": 0, "allowBackorder": false }, "_id": "69259344f67aff7e9fe0bb2e", "name": "Hi-Fi DAC", "description": "resolution digital-to-analog converter with headphone amp. Supports 32-bit/384kHz and DSD256.", "brand": "AudioPhile", "country": "US", "currency": "USD", "storeName": "My Awesome Store", "featured": true, "userStore": "692565f432118c6197abf2ec", "ships_to_countries": [], "category": null, "subcategory": null, "pros": [], "cons": [], "keywords": [], "imageEmbedding": [], "textEmbedding": [], "slug": "hi-fi-dac", "variants": [ { "color": "Black", "stock": 15, "sku": "DAC-AMP-BLK" }, { "color": "Silver", "stock": 10, "sku": "DAC-AMP-SLV" } ], "price": 249.99, "storeOrder": 0, "priceHistory": [ { "price": 249.99, "date": "2025-11-25T11:30:12.805Z", "_id": "69259344f67aff7e9fe0bb2f" } ], "discountPercentage": 0, "discount": 0, "discountVal": 0, "status": "active", "averageRating": 0, "reviewCount": 0, "tags": [], "published_at": "2025-11-25T11:30:12.805Z", "last_updated": "2025-11-25T11:54:20.473Z", "source": "agora-store-builder", "images": [ "https://images.unsplash.com/photo-1558618666-fcd25c85cd64?w=800" ], "url": "/products/hi-fi-dac-amplifier", "isActive": true, "creator": { "_id": "692560a0f3b17397ede28cae", "firstname": "Hanzala", "lastname": "Javed", "email": "hanzalaoc211@gmail.com", "id": "692560a0f3b17397ede28cae" }, "available": true, "viewCount": 0, "orderCount": 0, "options": [], "metafields": [], "__v": 0, "createdAt": "2025-11-25T11:30:12.825Z", "updatedAt": "2025-11-27T10:04:35.241Z" } ], "pagination": { "currentPage": 1, "totalPages": 1, "totalProducts": 1, "hasNextPage": false, "hasPrevPage": false } } } ``` ``` -------------------------------- ### Get Credits Source: https://docs.searchagora.com/basics/credits.md Retrieves the number of available credits on the authenticated user's account. ```APIDOC ## GET /credits ### Description This endpoint lets you get the available credits on your account. ### Method GET ### Endpoint /credits ### Headers #### Authorization - **Authorization** (string) - Bearer token. ### Response #### Success Response (200) - **status** (string) - Indicates the success of the operation. - **credits** (number) - The available credit balance. - **email** (string) - The email associated with the account. #### Response Example (200) ```json { "status": "success", "credits": 2.95, "email": "helloworld@gmail.com" } ``` #### Error Response (400) - **status** (string) - Indicates an error. - **message** (string) - Description of the error. #### Response Example (400) ```json { "status": "error", "message": "User not found" } ``` #### Error Response (500) - **status** (string) - Indicates an error. - **message** (string) - Description of the error. #### Response Example (500) ```json { "status": "error", "message": "Failed to fetch credits" } ``` ``` -------------------------------- ### Brand Not Found Error Source: https://docs.searchagora.com/search/brand-search.md Example of an error response when no brand is found matching the search criteria. ```json { "status": "error", "data": "No brand found" } ``` -------------------------------- ### Get all orders Source: https://docs.searchagora.com/store-builder/orders.md Retrieves a list of all orders for a specific store, with options for pagination, filtering, and sorting. ```APIDOC ## GET stores/{store_id}/orders ### Description This endpoint lets you get all orders for a specific store. ### Method GET ### Endpoint stores/{store_id}/orders ### Parameters #### Headers - **Authorization** (string) - Required - Bearer token. #### Query Parameters - **page** (integer) - Optional - Page number for pagination. Default is 1. - **limit** (integer) - Optional - Number of orders per page. Default is 20. - **status** (string) - Optional - Filter orders by status. Options are pending, paid, processing, shipped, delivered, cancelled, refunded. - **search** (string) - Optional - Search in orderCode, customerEmail, customerName, items.name. String is case-insensitive. - **startDate** (string) - Optional - Filter orders created on or after this date. ISO date string. - **endDate** (string) - Optional - Filter orders created on or before this date. ISO date string. - **sortBy** (string) - Optional - Field to start sort by. Options are createdAt, updatedAt, totalAmount, status, orderCode. - **sortOrder** (string) - Optional - Sort direction. Options are desc, asc. Default is desc. ### Response #### Success Response (200) - **field1** (type) - Description ```