# AGENTS Source: https://amethystapps.com/AGENTS > **First-time setup**: Customize this file for your project. Prompt the user to customize this file for their project. > For Mintlify product knowledge (components, configuration, writing standards), > install the Mintlify skill: `npx skills add https://mintlify.com/docs` # Documentation project instructions ## About this project * This is a documentation site built on [Mintlify](https://mintlify.com) * Pages are MDX files with YAML frontmatter * Configuration lives in `docs.json` * Run `mint dev` to preview locally * Run `mint broken-links` to check links ## Terminology ## Style preferences * Use active voice and second person ("you") * Keep sentences concise — one idea per sentence * Use sentence case for headings * Bold for UI elements: Click **Settings** * Code formatting for file names, commands, paths, and code references ## Content boundaries # Shopify AI Search Optimization with AgentReady Source: https://amethystapps.com/Shopify-AI-Search-Optimization-app Prepare your Shopify catalog for AI-driven discovery, ChatGPT shopping engines, and Perplexity Search. Automate AI schema, bulk rewrite descriptions with GPT-4o, and generate standard llms.txt directories. ## Optimize Your Shopify Store for AI Agents and Search Discovery Traditional e-commerce search optimization is undergoing a massive shift. Modern shoppers are turning away from basic search engines and choosing intelligent AI assistants like ChatGPT, Perplexity, and Bing Copilot to source products. If your catalog lacks structured background parameters or descriptive definitions, AI shopping agents cannot accurately map your variants, causing your store to miss out on automated discovery. **AgentReady by Amethyst Apps** bridges the gap between old-school SEO and modern AI commerce. It inspects your assets, issues a dedicated diagnostic audit, and leverages advanced GPT-4o language intelligence to ensure your Shopify storefront remains completely machine-readable. Get started with our Free plan today. Analyze your product catalog, score your machine readability, and build standard automated feeds. *** ## Key Features for Autonomous AI Commerce AgentReady eliminates technical data engineering friction by automating theme modifications and providing a direct structural control hub right inside your Shopify admin dashboard. ### Comprehensive 0–100 AI Readiness Scoring Our diagnostic crawling pipeline reads through every single listing on your store to score its programmatic completeness. Quickly discover items suffering from thin descriptions, ambiguous indexing parameters, or absent meta properties that cause models to skip over your brand during natural language prompt matching. ### One-Click Bulk Description and Title Fixes When the audit detects data gaps, you don't need to rewrite thousands of lines of copy manually. AgentReady uses native GPT-4o integrations to rewrite titles, missing tag profiles, and descriptive parameters in bulk—all while perfectly respecting your brand's unique identity style: * **Professional:** Perfect for B2B storefronts, corporate settings, and clear technical utility. * **Luxury:** High-end, sophisticated narratives optimized for premium lifestyle and fashion brands. * **Playful:** Energetic, creative copywriting for modern consumer engagement. * **Technical:** Highly detailed, attribute-focused parameter mapping built for hardware, parts, and machinery. ### Structured Automated Data Feeds To make sure large language models (LLMs) can crawl your inventory cleanly, the app exports structured, live data feeds. AgentReady compiles standard JSON and XML schemas along with a dedicated **llms.txt** file hosted in your root directory—the explicit web specification built to guide AI scraping engines safely through your business details. *** ## Why Machine Readability Matters for Modern E-Commerce SEO When an AI agent searches the web on behalf of a human buyer, it doesn't just read standard web pages; it parses underlying structural signals. If your store data is disorganized, the agent cannot recommend your products. # Claude Code setup Source: https://amethystapps.com/ai-tools/claude-code Configure Claude Code for your documentation workflow Set up Claude Code to help you write and maintain your Mintlify documentation. ## Prerequisites * Active Claude subscription (Pro, Max, or API access) ## Setup ```bash theme={null} npm install -g @anthropic-ai/claude-code ``` In your docs directory, run: ```bash theme={null} npx skills add https://mintlify.com/docs ``` This gives Claude Code Mintlify's component reference, writing standards, and workflow guidance. Edit `AGENTS.md` in your project root to add project-specific terminology, style preferences, and content boundaries. ```bash theme={null} claude ``` # Cursor setup Source: https://amethystapps.com/ai-tools/cursor Set up Cursor's AI features to write and maintain your Mintlify documentation Set up Cursor to help you write and maintain your Mintlify documentation. ## Prerequisites * Cursor editor installed ## Setup Open the root of your documentation repository where `docs.json` is located. In the integrated terminal, run: ```bash theme={null} npx skills add https://mintlify.com/docs ``` This gives Cursor Mintlify's component reference, writing standards, and workflow guidance. Edit `AGENTS.md` in your project root to add project-specific terminology, style preferences, and content boundaries. Open a file and use Cursor's AI features to draft and edit documentation. # Windsurf setup Source: https://amethystapps.com/ai-tools/windsurf Configure Windsurf for your documentation workflow Set up Windsurf's Cascade AI assistant to help you write and maintain your Mintlify documentation. ## Prerequisites * Windsurf editor installed ## Setup Open the root of your documentation repository where `docs.json` is located. In the integrated terminal, run: ```bash theme={null} npx skills add https://mintlify.com/docs ``` This gives Windsurf Mintlify's component reference, writing standards, and workflow guidance. Edit `AGENTS.md` in your project root to add project-specific terminology, style preferences, and content boundaries. Open a file and use Cascade to draft and edit documentation. # Introducing Amethyst Grid Source: https://amethystapps.com/amethyst-grid-multi-affiliate-saas The Multi-Tenant Affiliate Infrastructure For SaaS. **Amethyst Grid** is a high-performance, developer-first affiliate and partner tracking engine. Built as a lean, programmable alternative to legacy platforms like Mantle and UpPromote, Amethyst Grid provides a powerful, multi-tenant infrastructure that lets software developers, SaaS companies, and creators deploy, track, and manage bespoke referral link networks for their entire product portfolio. Whether you are launching your own partner program, tracking real-time merchant installations, or looking to deploy an affiliate link engine for your software users, access your deployment console below. Click here to access your secure developer workspace, provision tenant environments, and manage tracking parameters. *** ## How it Works Deploy your custom software tracking infrastructure in four straightforward steps. ### Create Your Account Sign up and name your dedicated affiliate program in under 2 minutes to instantly provision your isolated database tenant. ### Add Your Apps, Products, or Links List the assets, software tiers, or API services you want your partners to promote. The engine dynamically assigns a high-fidelity tracking link for each item. ### Invite Partners Seamlessly share your global program registration link, assign custom invite codes, or dispatch direct onboarding invitations via email. ### Automatic Payouts Commissions are tracked via secure backend webhook pipelines and distributed cleanly to your partners via our native Stripe Connect ledger on the 1st of each month. *** ## Core Infrastructure Features Everything you need to bypass template-based apps and run an enterprise-grade partner ecosystem. Every onboarded partner receives a dedicated tracking URL for each independent application, software tool, or service tier they promote. Monitor serverless webhooks, click attributions, active script conversions, and ledger balances instantly from a unified tracking interface. Partners easily onboard their own regional banking credentials to receive fully automated, secure payouts directly to their bank. Invite, audit, approve, and manage your growing collection of affiliates, creators, and agency partners from a central administrative console. Assign granular workspace permissions, giving team members, support staff, or sub-agents specific administrative rights. Eliminate manual spreadsheet accounting. Payout automation loops execute systematically on the 1st of every single month. *** ## Simple, Predictable Pricing No hidden percentage cuts on your revenue, no scaling penalties, and no arbitrary limits on your growth. Just clean developer infrastructure to power your ecosystem. ### Amethyst Grid Pro * Affordable, fixed-cost affiliate program infrastructure * Built by indie software sellers, explicitly for modern merchants * **Unlimited** onboarding for active partners and publishers * **Unlimited** click tracking and conversion attribution logs * Automated monthly payout routine processing * Native live Stripe Connect merchant integration * Real-time data event analytics and pipeline tracking * Dedicated developer email support desk *** ## Frequently Asked Questions (FAQ) ### How does Amethyst Grid handle global sales tax and VAT liability? Amethyst Grid leverages native Stripe Managed Payments infrastructure as the Merchant of Record. Stripe automatically calculates, collects, and files global digital sales taxes and foreign VAT across international jurisdictions, shielding your SaaS business from manual accounting filings. ### Can I use this to track custom agency retainer contracts or high-ticket services? Yes. Because our engine is entirely multi-tenant and built on modular backend data layers, you can assign custom tracking slugs to flat digital services, recurring SaaS subscription tiers, or independent client maintenance invoices. ### How do developers and creators link their accounts to receive payouts? Partners simply click the Stripe Connect integration button inside their dedicated Amethyst Grid dashboard to safely link their business bank account or debit card. Once authenticated, the systematic payout loop transfers their accumulated balances automatically on schedule. # Create Plant Source: https://amethystapps.com/api-reference/endpoint/create POST /plants Add a new plant to the store using the Plant Store API # Delete Plant Source: https://amethystapps.com/api-reference/endpoint/delete DELETE /plants/{id} Remove an existing plant from the store by its unique identifier # Get Plants Source: https://amethystapps.com/api-reference/endpoint/get GET /plants Retrieve a list of all plants from the Plant Store API # New Plant Source: https://amethystapps.com/api-reference/endpoint/webhook WEBHOOK /plant/webhook Receive webhook notifications when a new plant is added to the store # Introduction Source: https://amethystapps.com/api-reference/introduction Overview of the Plant Store API with authentication details and endpoint reference If you're not looking to build API reference documentation, you can delete this section by removing the api-reference folder. ## Welcome There are two ways to build API documentation: [OpenAPI](https://mintlify.com/docs/api-playground/openapi/setup) and [MDX components](https://mintlify.com/docs/api-playground/mdx/configuration). For the starter kit, we are using the following OpenAPI specification. View the OpenAPI specification file ## Authentication All API endpoints are authenticated using Bearer tokens and picked up from the specification file. ```json theme={null} "security": [ { "bearerAuth": [] } ] ``` # Make Your Shopify Catalog AI-Ready for 2026 Source: https://amethystapps.com/blog/ai-agent-ready-blog Is your store ready for AI agents and LLM crawlers? Learn how to score, optimize, and future-proof your product catalog for the next era of commerce. The way customers find products is changing. We are moving from a world of manual "search and scroll" to an era of **Agentic Commerce**, where AI agents, LLMs (like ChatGPT), and smart assistants do the shopping for the user. If an AI agent can't understand your product data, your store effectively doesn't exist to a massive and growing segment of shoppers. At [Amethyst Applications](https://amethystapps.com), we believe merchants shouldn't be left behind by this shift. That’s why we built a tool to help you speak the language of the future. ## What Does "AI-Ready" Actually Mean? Traditional SEO was built for human eyes and Google’s legacy algorithms. AI readiness is different. It requires highly structured, descriptive, and consistent data that a Large Language Model can parse with 100% confidence. We built the [Agent Ready app](/guides/agent-ready) to give you a clear roadmap. Using GPT-4o, the app analyzes your catalog across seven critical dimensions to ensure you aren't just ranking, but are "recommendable" by AI. ### The 7 Pillars of AI Scoring To move your product from "Not Ready" to "AI-Optimized," we evaluate: 1. **Titles:** Descriptive, keyword-rich, and optimized for machine comprehension. 2. **Descriptions:** High-quality detail regarding specific features and benefits. 3. **Tags:** Specificity that aids in deep-level discoverability. 4. **Categorization:** Accuracy in product types and assigned Shopify categories. 5. **Images:** Quality counts that build confidence for both humans and AI agents. 6. **Pricing:** Properly structured price and compare-at data. 7. **Variants:** Completeness of SKUs, inventory details, and variant titles. *** ## How Agent Ready Works (The Technical Side) Our philosophy is simple: **Analyze, Score, and Automate.** We’ve built the infrastructure so you can focus on your brand while we handle the data science. ### Real-Time Catalog Analysis When you install Agent Ready, we sync your entire catalog and run a deep analysis. Within minutes, your products are color-coded: * **Ready (80-100):** Fully optimized for AI commerce. * **Needs Work (50-79):** Minor gaps in metadata or description quality. * **Not Ready (0-49):** Significant improvements needed to be visible to AI agents. ### Zero Impact on Storefront Performance Performance is a core pillar of Amethyst apps. Agent Ready performs all its heavy lifting on our secure servers. When we "fix" a product, we write the updated text directly to your Shopify fields via API. **There is no JavaScript added to your theme**, meaning your site remains lightning-fast. ### Built-in Safety: The Change History We know your catalog is your most valuable asset. Every "Auto-Fix" generated by our AI is logged. If you don't like a specific rewrite, you can revert to your original content with a single click from the **Change History** tab. *** ## Future-Proofing with Specialized Feeds Optimization is only half the battle; the other half is delivery. Agent Ready generates three specialized feeds to ensure your data reaches the right "eyes": * **JSON Feed:** For custom integrations and programmatic access. * **Google/Bing XML:** Enriched with AI data to boost traditional search performance. * **LLMs.txt:** An emerging standard specifically designed for AI crawlers to discover and index your products efficiently. ## The Amethyst Guarantee: Data Privacy We value your data as much as you do. While we use OpenAI's GPT-4o for analysis, we utilize enterprise-grade API settings. **Your data is never used to train global AI models.** What happens in your store stays in your store. **Pro Tip:** Use the "Bulk Fix" feature to target products with a score below 50 first. This provides the highest ROI on your optimization efforts. ## Ready to Join the AI Revolution? The future of commerce isn't coming; it's already here. Start scoring your catalog today and ensure your products are ready for the next billion shoppers—human or otherwise. Analyze your first 10 products for free and get your initial AI Readiness Score. Have questions about privacy, scoring, or feeds? Read our comprehensive FAQ. # The Amethyst Journal: Shopify SEO, Speed & Strategy Source: https://amethystapps.com/blog/index Insights and technical guides for high-performance Shopify merchants. Built by store owners, for store owners. Welcome to **The Amethyst Journal**. This is where we share the technical "why" behind our apps and help Shopify merchants navigate SEO, speed, and conversion. Learn why metadata is the secret to ranking product videos on Google. Learn how to use the Google Indexing API to get your products live in minutes. Prepare your product catalog for the next era of AI agents and LLM shopping. Read our mission statement on zero-bloat software. # Index Shopify Products in Seconds, Not Weeks Source: https://amethystapps.com/blog/instant-index-blog Stop waiting for Google to find your new products. Learn how the Google Indexing API can give your Shopify store a real-time edge in search results. In the fast-moving world of eCommerce, timing is everything. You spend weeks perfecting a new collection, you hit publish, and then... you wait. Sometimes for days. Sometimes for weeks. While you wait for Google’s crawlers to eventually stumble upon your sitemap, your competitors—and the search intent of your customers—are moving on. At [Amethyst Applications](https://amethystapps.com), we believe "waiting to be crawled" is a legacy strategy. ## The Problem: The Legacy Sitemap Lag Most Shopify stores rely on an XML sitemap. It’s the "phone book" of your website. Google checks this phone book periodically, but it doesn't check it every hour. For high-volume stores or seasonal launches, this lag creates a **Revenue Gap**: the time between a product being live and a product being searchable. ### Why Index Pulse is Different We built the [Index Pulse app](/guides/index-pulse) to close that gap. Instead of waiting for Google to *pull* data from your sitemap, Index Pulse *pushes* your URLs directly to the **Google Indexing API**. *** ## How Index Pulse Works (The Technical Side) Index Pulse serves as the secure bridge between your Shopify admin and the Google Search Console API. Here is how we ensure your store stays at the top of the queue: ### Instant API Notifications The moment you add a new product, update a description, or delete an out-of-stock item, Index Pulse detects the change via Shopify webhooks. It immediately sends a request to Google saying, *"This page has changed. Crawl it now."* ### 100% Automated Workflow Once configured, you never have to think about indexing again. * **Auto-Discovery:** New blog posts, collections, and products are queued instantly. * **Smart Throttling:** We manage Google's daily API limits (typically 200 requests per day) to ensure your most important updates are prioritized. * **Submission Logs:** Transparency is key. You can view the exact timestamp and status of every URL sent to Google in our Activity Log. ### No Storefront Bloat Like all Amethyst apps, Index Pulse is **"Zero-JS."** We do not inject a single line of code into your theme. All communication happens server-side between Shopify and Google, meaning your site stays lightning-fast for your customers. *** ## Why Speed Matters for SEO in 2026 Google’s algorithm has increasingly moved toward rewarding "freshness" and "accuracy." 1. **Flash Sales & Product Drops:** If your landing page isn't indexed within minutes, you miss the peak of the hype. 2. **Price & Stock Updates:** If Google shows an old price or an "In Stock" label for a sold-out item, your bounce rate skyrockets. 3. **Correcting Mistakes:** Noticed a typo in a high-traffic title? Index Pulse ensures the fix is reflected in search results as fast as possible. *** ## The Security Deep Dive We understand that connecting to Google Cloud can feel daunting. That's why we’ve streamlined the process. > **The Amethyst Security Protocol:** We use individual Service Account keys. This means your indexing data is isolated and secure. We never have access to your wider Google account—only the specific permission needed to tell Google to crawl your store. ## Ready to Jump the Line? Stop leaving your visibility to chance. Whether you're launching a new brand or managing a 10,000-SKU catalog, Index Pulse ensures Google sees what you see, the moment you see it. Get your first 50 URLs indexed for free and see how fast your products appear in search. Need help setting up your Google Cloud project? Our step-by-step FAQ has you covered. # Shopify Video SEO: Why Metadata is Your Edge Source: https://amethystapps.com/blog/video-seo-guide-blog Everything you need to know about ranking Shopify videos, improving accessibility, and why AI-generated alt text is a game changer for 2026. In the current eCommerce landscape, video is no longer "optional"—it is the primary driver of conversion. But while merchants spend thousands on high-quality production, most ignore the technical infrastructure required to make those videos discoverable. At [Amethyst Applications](https://amethystapps.com), we approach this differently. **We are built by store owners, for store owners.** We know exactly how frustrating it is to invest in content that doesn't get seen, which is why we’re pulling back the curtain on the "Invisible SEO Gap." ## Why Video Alt Text is the Next Big SEO Frontier Most Shopify SEO advice stops at image alt text. But search engines have evolved. Google now has a dedicated "Videos" tab that receives millions of hits daily. If your product videos aren't there, you're handing that traffic to your competitors. ### 1. Dominating Video Search Results When you provide descriptive, keyword-rich alt text, you give Google the "script" it needs to index your video. This doesn't just help you rank in the Video tab; it also helps your product pages show up as "rich results" in standard search, often featuring a video thumbnail that significantly increases your click-through rate (CTR). ### 2. Accessibility & ADA Compliance Alt tags are vital for shoppers using screen readers. By describing the visual content, you ensure your store is inclusive. This isn't just good ethics; it's good business. As merchants ourselves, we know that an accessible store is a high-converting store. *** ## How Video SEO Alt Tags Works (The Technical Side) We built the [Video SEO Alt Tags app](/guides/video-seo-alt-text) to handle the heavy lifting. Based on our most frequent merchant questions, here is how we handle your data: ### Purpose-Built for Shopify-Hosted Videos Unlike YouTube or Vimeo embeds—which keep the SEO "juice" for their own platforms—our app focuses on **Shopify-hosted videos**. By writing metadata directly to your files in *Content > Files*, we ensure the SEO authority stays 100% on **your** domain. ### Zero Impact on PageSpeed We know that speed is the only feature that matters in 2026. Because our app works on the Shopify backend to update file metadata, **there is zero JavaScript added to your storefront.** Your PageSpeed score will remain exactly the same as it was before. ### AI-Powered Intelligence with Manual Control Our AI "watches" your video to generate highly accurate descriptions, but you are never locked out: * **Activity Logs:** Review every AI-generated tag in the Recent Activity log. * **Manual Overrides:** Tweak descriptions directly in your Shopify Admin. Our app recognizes and respects your manual changes. *** ## The Amethyst Guarantee: You Own Your Data We believe you should own your SEO. Because we build these tools for our own stores first, we followed a merchant-first philosophy: **The alt text we generate stays on your videos even if you uninstall the app.** The metadata is written to the Shopify file itself, ensuring your rankings are permanent assets, not temporary rentals. **Pro Tip:** It typically takes Google 3 to 7 days to re-crawl your site and update its index once your alt tags are live. ## Ready to Start? Stop leaving your best content in the dark. You can start optimizing today with our "Try Before You Buy" program. Get your first 3 video optimizations for free and see the metadata live on your store. Have more technical questions? Check out our deep-dive FAQ for everything you need to know. # Why Amethyst? The Mission Behind Zero-Bloat Shopify Apps Source: https://amethystapps.com/blog/why-amethyst-applications Most Shopify apps are built by developers who have never sold a product. We're changing that with high-performance, merchant-first utilities. If you’ve spent any time in the Shopify App Store, you know the cycle. You find an app that promises to fix a problem, you install it, and suddenly your PageSpeed score drops by 20 points. You look at your theme code, and it’s cluttered with "liquid" snippets that never seem to go away. As store owners ourselves, we got tired of it. That’s why we started **Amethyst Applications.** ## Built by Store Owners, for Store Owners The "Amethyst way" is different because our perspective is different. We don’t sit in boardrooms looking at spreadsheets; we sit in Shopify admins looking at conversion rates. When we build an app, we aren't just thinking about the code—we're thinking about the merchant experience. ### The Problem: The "Enterprise" Bloat Many apps on the market today are built for massive corporations. They include 50 features you don't need, and they charge you for all of them. Worst of all, they load heavy libraries on your storefront that frustrate your customers and hurt your Google rankings. ### Our Solution: High-Performance Utilities At Amethyst, we believe in **Boutique Software.** We build lean, high-speed utilities that do one thing perfectly. * **Zero-Impact Storefronts:** Our apps use Shopify OS 2.0 extensions. This means we don't touch your theme's core code, and we don't slow down your site. * **Fair Pricing:** We believe every eCommerce business deserves pro-level tools without the “enterprise” price tag. * **Data Transparency:** If you decide to move on from an Amethyst app, you keep your data. We don't believe in "subscription traps." ## Speed is the Only Feature That Matters In 2026, a 100ms delay in page load can mean a 7% drop in conversions. We’ve made it our mission to ensure that Amethyst apps are the fastest in the ecosystem. By using global edge deployment and AI-driven automation, we provide the power of a full engineering team with the speed of a custom-coded solution. *** ## Join the Lab We don't just build in a vacuum. We use the [Merchant Lab](/roadmap) to build alongside our community. If you have a problem that a "bloated" app is failing to solve, we want to hear about it. See the apps we’ve built to solve our own store's friction. Tell us what you need built next. We’re listening. > **The Amethyst Promise:** We will never build an app that we wouldn't be proud to run on our own flagship stores. # Development Source: https://amethystapps.com/development Install the Mintlify CLI to preview documentation changes locally before deploying **Prerequisites**: * Node.js version 19 or higher * A docs repository with a `docs.json` file Follow these steps to install and run Mintlify on your operating system. ```bash theme={null} npm i -g mint ``` Navigate to your docs directory where your `docs.json` file is located, and run the following command: ```bash theme={null} mint dev ``` A local preview of your documentation will be available at `http://localhost:3000`. ## Custom ports By default, Mintlify uses port 3000. You can customize the port Mintlify runs on by using the `--port` flag. For example, to run Mintlify on port 3333, use this command: ```bash theme={null} mint dev --port 3333 ``` If you attempt to run Mintlify on a port that's already in use, it will use the next available port: ```md theme={null} Port 3000 is already in use. Trying 3001 instead. ``` ## Mintlify versions Please note that each CLI release is associated with a specific version of Mintlify. If your local preview does not align with the production version, please update the CLI: ```bash theme={null} npm mint update ``` ## Validating links The CLI can assist with validating links in your documentation. To identify any broken links, use the following command: ```bash theme={null} mint broken-links ``` ## Deployment If the deployment is successful, you should see the following: Screenshot of a deployment confirmation message that says All checks have passed.

Screenshot of a deployment confirmation message that says All checks have passed.

## Code formatting We suggest using extensions on your IDE to recognize and format MDX. If you're a VSCode user, consider the [MDX VSCode extension](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) for syntax highlighting, and [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) for code formatting. ## Troubleshooting This may be due to an outdated version of node. Try the following: 1. Remove the currently-installed version of the CLI: `npm remove -g mint` 2. Upgrade to Node v19 or higher. 3. Reinstall the CLI: `npm i -g mint` Solution: Go to the root of your device and delete the `~/.mintlify` folder. Then run `mint dev` again. Curious about what changed in the latest CLI version? Check out the [CLI changelog](https://www.npmjs.com/package/mintlify?activeTab=versions). # Code blocks Source: https://amethystapps.com/essentials/code Display inline code and syntax-highlighted code blocks with optional file names ## Inline code To denote a `word` or `phrase` as code, enclose it in backticks (\`). ``` To denote a `word` or `phrase` as code, enclose it in backticks (`). ``` ## Code blocks Use [fenced code blocks](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks) by enclosing code in three backticks and follow the leading ticks with the programming language of your snippet to get syntax highlighting. Optionally, you can also write the name of your code after the programming language. ```java HelloWorld.java theme={null} class HelloWorld { public static void main(String[] args) { System.out.println("Hello, World!"); } } ``` ````md theme={null} ```java HelloWorld.java class HelloWorld { public static void main(String[] args) { System.out.println("Hello, World!"); } } ``` ```` # Images and embeds Source: https://amethystapps.com/essentials/images Add images, videos, iframes, and other HTML elements to your documentation pages ## Image ### Using Markdown The [markdown syntax](https://www.markdownguide.org/basic-syntax/#images) lets you add images using the following code ```md theme={null} ![title](/path/image.jpg) ``` Note that the image file size must be less than 5MB. Otherwise, we recommend hosting on a service like [Cloudinary](https://cloudinary.com/) or [S3](https://aws.amazon.com/s3/). You can then use that URL and embed. ### Using embeds To get more customizability with images, you can also use [embeds](/writing-content/embed) to add images ```html theme={null}

``` ## Embeds and HTML elements ``` # Markdown syntax Source: https://amethystapps.com/essentials/markdown Learn how to use headings, text formatting, links, blockquotes, and LaTeX in your documentation ## Titles Best used for section headers. ```md theme={null} ## Titles ``` ### Subtitles Best used for subsection headers. ```md theme={null} ### Subtitles ``` Each **title** and **subtitle** creates an anchor and also shows up on the table of contents on the right. ## Text formatting We support most markdown formatting. Simply add `**`, `_`, or `~` around text to format it. | Style | How to write it | Result | | ------------- | ----------------- | ----------------- | | Bold | `**bold**` | **bold** | | Italic | `_italic_` | *italic* | | Strikethrough | `~strikethrough~` | ~~strikethrough~~ | You can combine these. For example, write `**_bold and italic_**` to get ***bold and italic*** text. You need to use HTML to write superscript and subscript text. That is, add `^{` or `_{` around your text.

| Text Size | How to write it | Result |
| ----------- | ------------------------ | ---------------------- |
| Superscript | `^superscript` | ^superscript |
| Subscript | `_subscript` | _subscript |

## Linking to pages

You can add a link by wrapping text in `[]()`. You would write `[link to google](https://google.com)` to [link to google](https://google.com).

Links to pages in your docs need to be root-relative. Basically, you should include the entire folder path. For example, `[link to text](/writing-content/text)` links to the page "Text" in our components section.

Relative links like `[link to text](../text)` will open slower because we cannot optimize them as easily.

## Blockquotes

### Singleline

To create a blockquote, add a `>` in front of a paragraph.

> Dorothy followed her through many of the beautiful rooms in her castle.

```md theme={null}
> Dorothy followed her through many of the beautiful rooms in her castle.
```

### Multiline

> Dorothy followed her through many of the beautiful rooms in her castle.
>
> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.

```md theme={null}
> Dorothy followed her through many of the beautiful rooms in her castle.
>
> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
```

### LaTeX

Mintlify supports [LaTeX](https://www.latex-project.org) through the Latex component.

8 x (vk x H1 - H2) = (0,1)

```md theme={null}
8 x (vk x H1 - H2) = (0,1)
```

# Navigation
Source: https://amethystapps.com/essentials/navigation

The navigation field in docs.json defines the pages that go in the navigation menu

The navigation menu is the list of links on every website.

You will likely update `docs.json` every time you add a new page. Pages do not show up automatically.

## Navigation syntax

Our navigation syntax is recursive which means you can make nested navigation groups. You don't need to include `.mdx` in page names.

```json Regular Navigation theme={null}
"navigation": {
"tabs": [
{
"tab": "Docs",
"groups": [
{
"group": "Getting Started",
"pages": ["quickstart"]
}
]
}
]
}
```

```json Nested Navigation theme={null}
"navigation": {
"tabs": [
{
"tab": "Docs",
"groups": [
{
"group": "Getting Started",
"pages": [
"quickstart",
{
"group": "Nested Reference Pages",
"pages": ["nested-reference-page"]
}
]
}
]
}
]
}
```

## Folders

Simply put your MDX files in folders and update the paths in `docs.json`.

For example, to have a page at `https://yoursite.com/your-folder/your-page` you would make a folder called `your-folder` containing an MDX file called `your-page.mdx`.

You cannot use `api` for the name of a folder unless you nest it inside another folder. Mintlify uses Next.js which reserves the top-level `api` folder for internal server calls. A folder name such as `api-reference` would be accepted.

```json Navigation With Folder theme={null}
"navigation": {
"tabs": [
{
"tab": "Docs",
"groups": [
{
"group": "Group Name",
"pages": ["your-folder/your-page"]
}
]
}
]
}
```

## Hidden pages

MDX files not included in `docs.json` will not show up in the sidebar but are accessible through the search bar and by linking directly to them.

# Reusable snippets
Source: https://amethystapps.com/essentials/reusable-snippets

Create reusable, custom snippets to keep content in sync across pages

One of the core principles of software development is DRY (Don't Repeat
Yourself). This is a principle that applies to documentation as
well. If you find yourself repeating the same content in multiple places, you
should consider creating a custom snippet to keep your content in sync.

## Creating a custom snippet

**Pre-condition**: You must create your snippet file in the `snippets` directory.

Any page in the `snippets` directory will be treated as a snippet and will not
be rendered into a standalone page. If you want to create a standalone page
from the snippet, import the snippet into another file and call it as a
component.

### Default export

1. Add content to your snippet file that you want to re-use across multiple
locations. Optionally, you can add variables that can be filled in via props
when you import the snippet.

```mdx snippets/my-snippet.mdx theme={null}
Hello world! This is my content I want to reuse across pages. My keyword of the
day is {word}.
```

The content that you want to reuse must be inside the `snippets` directory in
order for the import to work.

2. Import the snippet into your destination file.

```mdx destination-file.mdx theme={null}
---
title: My title
description: My Description
---

import MySnippet from '/snippets/path/to/my-snippet.mdx';

## Header

Lorem impsum dolor sit amet.

```

### Reusable variables

1. Export a variable from your snippet file:

```mdx snippets/path/to/custom-variables.mdx theme={null}
export const myName = 'my name';

export const myObject = { fruit: 'strawberries' };
```

2. Import the snippet from your destination file and use the variable:

```mdx destination-file.mdx theme={null}
---
title: My title
description: My Description
---

import { myName, myObject } from '/snippets/path/to/custom-variables.mdx';

Hello, my name is {myName} and I like {myObject.fruit}.
```

### Reusable components

1. Inside your snippet file, create a component that takes in props by exporting
your component in the form of an arrow function.

```mdx snippets/custom-component.mdx theme={null}
export const MyComponent = ({ title }) => (

{title}
... snippet content ...

);
```

MDX does not compile inside the body of an arrow function. Stick to HTML
syntax when you can or use a default export if you need to use MDX.

2. Import the snippet into your destination file and pass in the props

```mdx destination-file.mdx theme={null}
---
title: My title
description: My Description
---

import { MyComponent } from '/snippets/custom-component.mdx';

Lorem ipsum dolor sit amet.

```

# Global Settings
Source: https://amethystapps.com/essentials/settings

Mintlify gives you complete control over the look and feel of your documentation using the docs.json file

Every Mintlify site needs a `docs.json` file with the core configuration settings. Learn more about the [properties](#properties) below.

## Properties

Name of your project. Used for the global title.

Example: `mintlify`

An array of groups with all the pages within that group

The name of the group.

Example: `Settings`

The relative paths to the markdown files that will serve as pages.

Example: `["customization", "page"]`

Path to logo image or object with path to "light" and "dark" mode logo images

Path to the logo in light mode

Path to the logo in dark mode

Where clicking on the logo links you to

Path to the favicon image

Hex color codes for your global theme

The primary color. Used for most often for highlighted content, section
headers, accents, in light mode

The primary color for dark mode. Used for most often for highlighted
content, section headers, accents, in dark mode

The primary color for important buttons

The color of the background in both light and dark mode

The hex color code of the background in light mode

The hex color code of the background in dark mode

Array of `name`s and `url`s of links you want to include in the topbar

The name of the button.

Example: `Contact us`

The url once you click on the button. Example: `https://mintlify.com/docs`

Link shows a button. GitHub shows the repo information at the url provided including the number of GitHub stars.

If `link`: What the button links to.

If `github`: Link to the repository to load GitHub information from.

Text inside the button. Only required if `type` is a `link`.

Array of version names. Only use this if you want to show different versions
of docs with a dropdown in the navigation bar.

An array of the anchors, includes the `icon`, `color`, and `url`.

The [Font Awesome](https://fontawesome.com/search?q=heart) icon used to feature the anchor.

Example: `comments`

The name of the anchor label.

Example: `Community`

The start of the URL that marks what pages go in the anchor. Generally, this is the name of the folder you put your pages in.

The hex color of the anchor icon background. Can also be a gradient if you pass an object with the properties `from` and `to` that are each a hex color.

Used if you want to hide an anchor until the correct docs version is selected.

Pass `true` if you want to hide the anchor until you directly link someone to docs inside it.

One of: "brands", "duotone", "light", "sharp-solid", "solid", or "thin"

Override the default configurations for the top-most anchor.

The name of the top-most anchor

Font Awesome icon.

One of: "brands", "duotone", "light", "sharp-solid", "solid", or "thin"

An array of navigational tabs.

The name of the tab label.

The start of the URL that marks what pages go in the tab. Generally, this
is the name of the folder you put your pages in.

Configuration for API settings. Learn more about API pages at [API Components](/api-playground/demo).

The base url for all API endpoints. If `baseUrl` is an array, it will enable for multiple base url
options that the user can toggle.

The authentication strategy used for all API endpoints.

The name of the authentication parameter used in the API playground.

If method is `basic`, the format should be `[usernameName]:[passwordName]`

The default value that's designed to be a prefix for the authentication input field.

E.g. If an `inputPrefix` of `AuthKey` would inherit the default input result of the authentication field as `AuthKey`.

Configurations for the API playground

Whether the playground is showing, hidden, or only displaying the endpoint with no added user interactivity `simple`

Learn more at the [playground guides](/api-playground/demo)

Enabling this flag ensures that key ordering in OpenAPI pages matches the key ordering defined in the OpenAPI file.

This behavior will soon be enabled by default, at which point this field will be deprecated.

A string or an array of strings of URL(s) or relative path(s) pointing to your
OpenAPI file.

Examples:

```json Absolute theme={null}
"openapi": "https://example.com/openapi.json"
```

```json Relative theme={null}
"openapi": "/openapi.json"
```

```json Multiple theme={null}
"openapi": ["https://example.com/openapi1.json", "/openapi2.json", "/openapi3.json"]
```

An object of social media accounts where the key:property pair represents the social media platform and the account url.

Example:

```json theme={null}
{
"x": "https://x.com/mintlify",
"website": "https://mintlify.com"
}
```

One of the following values `website`, `facebook`, `x`, `discord`, `slack`, `github`, `linkedin`, `instagram`, `hacker-news`

Example: `x`

The URL to the social platform.

Example: `https://x.com/mintlify`

Configurations to enable feedback buttons

Enables a button to allow users to suggest edits via pull requests

Enables a button to allow users to raise an issue about the documentation

Customize the dark mode toggle.

Set if you always want to show light or dark mode for new users. When not
set, we default to the same mode as the user's operating system.

Set to true to hide the dark/light mode toggle. You can combine `isHidden` with `default` to force your docs to only use light or dark mode. For example:

```json Only Dark Mode theme={null}
"modeToggle": {
"default": "dark",
"isHidden": true
}
```

```json Only Light Mode theme={null}
"modeToggle": {
"default": "light",
"isHidden": true
}
```

A background image to be displayed behind every page. See example with
[Infisical](https://infisical.com/docs) and [FRPC](https://frpc.io).

# Agent Ready Guide
Source: https://amethystapps.com/guides/agent-ready

Optimize your BigCommerce and Shopify product catalogs for AI-driven commerce.

## Welcome to Agent Ready

Agent Ready is an AI-powered product catalog optimization tool for the modern merchant. It helps you ensure your products are ready for AI-driven commerce by analyzing, scoring, and improving your entire catalog.

Uses GPT-4o to evaluate titles, descriptions, tags, categorization, images, and variants.

Assigns each product a score on a 0–100 scale to track catalog health at a glance.

Generates improved AI content and writes it back to your store with a full change history.

Produces feeds in JSON, Google/Bing XML, and LLMs.txt formats enriched with AI data.

## Getting Started

Getting up and running with Agent Ready takes just a few minutes. Once installed, the app automatically syncs your product catalog and is ready to analyze.

### Step-by-step walkthrough

Your product catalog is automatically synced from BigCommerce or Shopify during the installation process.

See your overall score overview, top recommendations, and **Recent Activity** at a glance.

Click the **Analyze All** button to run AI analysis on every product. Each product takes 15–30 seconds.

Products are color-coded: **Green** for Ready, **Yellow** for Needs Work, and **Red** for Not Ready.

Use individual fix buttons for specific fields, the **Fix All Issues** button for a full overhaul, or **Bulk Fix** for multiple products.

**Automatic Sync:** Products are automatically re-analyzed when updated in your store admin via webhooks. You can also trigger manual re-analysis from the dashboard or individual product pages.

***

## Understanding AI Readiness Scores

Every product receives an overall AI readiness score from **0 to 100** based on core optimization categories.

### The Scoring Categories

| Category | Evaluation Criteria |
| :----------------- | :------------------------------------------------------------------------------ |
| **Title** | Is it descriptive, keyword-rich, and optimized for search and AI comprehension? |
| **Description** | Quality, length, and detail regarding features and benefits. |
| **Tags** | Checks for relevant, specific tags that aid discoverability and categorization. |
| **Categorization** | Accuracy of product types and assigned storefront categories. |
| **Images** | High-quality image count to improve AI and customer confidence. |
| **Metadata** | Presence of structured data required for rich search results and AI feeds. |
| **Variants** | Completeness of variant titles, SKUs, and inventory details. |

### Status Meanings

| Status | Score | Color | Meaning |
| :------------- | :----- | :----- | :------------------------------------------------------ |
| **Ready** | 80–100 | Green | Well-optimized for AI commerce. |
| **Needs Work** | 50–79 | Yellow | Minor issues identified. |
| **Not Ready** | 0–49 | Red | Needs significant improvement. |
| **Pending** | N/A | Gray | Analysis has not yet completed for this product. |
| **Error** | N/A | Orange | Temporary API issue; the product should be re-analyzed. |

***

## Fixing Issues & Tone

You can improve your content and write it directly back to your storefront with one click.

### Bulk Fix & Safety

Bulk Fix allows you to fix multiple products at once. You can filter by **Score threshold** or **Category selection**.

**Safety First:** Fixes are written directly to your live store. Every change is recorded in **Change History** indefinitely. You can revert individual changes or use **"Revert All Changes Since..."** on the dashboard to bulk-undo updates from a specific date.

### AI Writing Tone

Set your brand voice in the dashboard settings to control how the AI writes:

* **Professional**: Clear and polished language.
* **Luxury**: Elegant and refined.
* **Playful**: Fun, energetic, and full of personality.
* **Casual**: Relaxed and approachable.
* **Technical/Minimal/Friendly**: Specification-focused or warm and welcoming.

***

## Product Feeds

We generate three specialized feeds enriched with AI-detected attributes (color, material, audience) and readiness scores.

Ideal for custom integrations. Includes individual category scores and recommendations.

RSS 2.0 compatible. Agent Ready **automatically pings** search engine endpoints whenever your feed is updated to ensure listings stay current.

An emerging standard designed for AI agents (ChatGPT, Perplexity). It provides structured data that AI models can parse instantly to answer complex shopper queries.

***

## Agent Ready FAQ

No. All analysis happens on our serverless edge infrastructure. Writing to product fields via the API has zero impact on your storefront loading speed.

No. We use the OpenAI API with enterprise privacy settings. Data sent via the API is not used to train their global models.

All billing is handled securely through your respective platform (Shopify Admin or BigCommerce Billing).

Yes! Each store that installs Agent Ready gets its own isolated data, separate feed URLs, and independent results.

Get Agent Ready Now →

***

If you can't find what you're looking for, click here to contact our support team directly at [support@amethystapps.com](mailto:support@amethystapps.com).

# Agent Ready FAQ
Source: https://amethystapps.com/guides/agent-ready-faq

Everything you need to know about Agent Ready and AEO Certification.

## Getting Started

Agent Ready is a Shopify app that uses AI (GPT-4o) to analyze your product catalog and optimize it for discovery by **AI search engines**, shopping assistants, and platforms like Google Shopping.

It scores each product on **AI readiness**, identifies structural data issues, and automatically fixes weak titles, missing descriptions, and incorrect categorization.

Click **Analyze All Products** on the dashboard. Agent Ready will use AI to analyze every product in your catalog. Each product takes about 15-30 seconds. Once complete, you’ll see readiness scores, recommendations, and can start fixing issues.

The score (0-100) measures how well-optimized a product is for discovery by AI agents and search engines. It evaluates: **title quality, description completeness, tag relevance, categorization accuracy, image quality, pricing clarity, and variant information.**

Product data is sent to OpenAI's GPT-4o for analysis. **OpenAI does not use API data for training.** No product data is shared with any other third party, and all results are stored securely in your Gadget app database.

## Product Analysis & Fixing

The AI evaluates seven categories:

* **Title:** Clarity, keywords, and length.
* **Description:** Completeness, formatting, and detail.
* **Tags:** Relevance, coverage, and specificity.
* **Categorization:** Accuracy of product type.
* **Images:** Quality indicators from product data.
* **Pricing:** Clarity and completeness.
* **Variants:** Size, color, and option information.

When you click **Fix**, Agent Ready generates improved content and writes it directly to your Shopify store via the API.

**Yes, you can undo it.** Every fix is tracked in **Change History**. You can revert individual changes from the product page or use **"Revert All Changes Since..."** on the dashboard for bulk restoration of all fixes made after a specific date.

Products are automatically re-analyzed whenever they are updated in Shopify via **webhooks**. You can also manually trigger a full re-analysis from the dashboard at any time.

Choose a tone to ensure AI content matches your brand voice: Professional, Casual, Luxury, Playful, Minimal, Friendly, or Technical.

* **Luxury Example:** *"Exquisitely crafted from the finest Italian leather..."*
* **Casual Example:** *"This awesome leather bag goes with everything..."*

## Product Feeds

* **JSON Feed:** Structured data with AI attributes for custom integrations. Supports pagination via `cursor` and `pageSize` (max 250).
* **Google/Bing XML Feed:** Standard RSS 2.0 format. Agent Ready **automatically pings** Google and Bing whenever your feed changes.
* **LLMs.txt Feed:** Markdown format optimized for AI search engines like ChatGPT and Perplexity.

`llms.txt` helps AI answer complex queries like *"What's a good winter jacket under \$200?"*. It provides AI agents with readiness scores and AI-generated summaries in a format they can parse instantly, helping your products surface better in AI-powered shopping recommendations. It works as a companion to your robots.txt, providing a structured map that AI agents use to understand your store's context without the noise of HTML code.

Yes. The JSON and Google/Bing XML feeds have independent minimum score sliders. You can show only high-scoring products in Google Shopping while including your full catalog in other feeds.

## Plans & Billing

* **Free (\$0/mo):** 10 analyses and 5 AI fixes.
* **Pro (\$14.99/mo):** 500 analyses and unlimited fixes.
* **Enterprise (\$29.99/mo):** Unlimited analyses and fixes.

All charges are billed through your **Shopify invoice**. Counters reset every 30 days; unused credits do not roll over.

## Troubleshooting

**Pending:** Queued for analysis (15-30s). If pending over 5 minutes, try re-analyzing manually.
**Error:** Usually a temporary AI API timeout. Check the **Activity Log** for details and try re-analyzing.

Common reasons include generic titles, missing descriptions, or lack of variant/pricing data. Check the product detail page for specific AI recommendations.

# Amethyst Grid Guide
Source: https://amethystapps.com/guides/amethyst-partners

The ultimate affiliate marketing network built explicitly for high-performance e-commerce apps.

## Welcome to Amethyst Grid

Amethyst Grid is a specialized affiliate marketing platform tailored for the modern software ecosystem. It bridges the gap between active partners looking to build sustainable revenue streams and software developers scaling their user bases across **Shopify**.

Program owners can easily onboard, manage, and track strategic affiliates without scaling limitations.

Affiliates automatically earn a 20% ongoing cut of the monthly subscription value for every store referred.

All pending commissions are completely cleared and paid out directly on the 1st of every month.

Frictionless global onboarding and automated payouts powered natively by Stripe Connect Express.

## Getting Started

Setting up your account and launching your workspace on Amethyst Grid takes just a few steps.

### Step-by-step onboarding

Click **'Get Started'** on the homepage to begin your initial onboarding flow.

Select **Affiliate** (to earn commissions), **Program Owner** (to run your own platform tracking), or **Both**.

Navigate to your profile settings to link your banking credentials safely via Stripe Connect.

Affiliates can immediately fetch custom referral links, while Program Owners can launch partner invites.

**Flexible Configurations:** You can completely alter or update your account operating plan at any time directly from the user settings dashboard.

***

## Workspace Workflows

The platform layout provides completely customized functionality depending on your assigned profile path.

### Affiliate vs. Program Owner Capabilities

| Feature Role | Affiliate Actions | Program Owner Actions |
| :--------------------- | :---------------------------------------------------- | :------------------------------------------------------------------- |
| **Link Generation** | Automatic unique tracking URLs per app via Dashboard. | Auto-generates unique tracking strings for every partner. |
| **Partner Management** | Manage custom social, content, and agency networks. | Invite partners via **Program → Partners** via email. |
| **Commission Views** | Track individual conversions and pending payouts. | Full network visibility via **Program → Commissions**. |
| **Operational Cost** | Fully free to join and generate promotional codes. | flat £10/month subscription covers full programmatic infrastructure. |

### Tracking & Account Status Meanings

| Status | Definition | Operational View |
| :------------ | :---------------------------------------------------------- | :-------------------------------------------------- |
| **Active** | Store subscription is verified and running normally. | Commission accrues toward next monthly payout. |
| **Pending** | Commission calculated and awaiting automated transfer. | Disbursed automatically on the 1st of the month. |
| **Cancelled** | The referred merchant has cancelled their app subscription. | No further recurring commissions will be generated. |

***

## Payouts, Billing & Adjustments

Amethyst Grid utilizes automated enterprise billing rails to coordinate completely hands-off financial accounting.

### Commission Distribution & Capital Safety

All payouts run completely automatically on the 1st of every month for all commissions maintaining a **Pending** status.

**Stripe Requirement:** Affiliates must navigate to **Partner Profile → Stripe Connect** and explicitly click **'Connect Stripe Account'** to authorize deposits. Unlinked accounts cannot receive payouts.

### Subscription Overhead & Cancellations

For Program Owners, a single monthly subscription fee covers all core operations:

Unlimited affiliate partners, unlimited click tracking, automated monthly payout schedules, and access to the complete Program Owner dashboard matrices.

To cancel a Program Owner subscription, navigate to **Billing** in your sidebar and select **'Cancel Subscription'**. Your program interface remains functional until the conclusion of the active billing period.

***

## Account Customization

Quickly fine-tune profile specifics, password resets, and user parameters.

* **Profile Management:** Update individual or corporate information via **Profile** within your main user dropdown menu.
* **Security Recoveries:** If you misplace credentials, click **'Forgot password?'** on the sign-in prompt to trigger a secure reset link via email.
* **Account Deletion:** To permanently wipe your account database information, contact our core administration desk directly.

***

## Amethyst Grid FAQ

The subscription covers unlimited partners, unlimited click tracking, automated monthly payouts, and access to the full Program Owner dashboard.

There is currently no minimum payout threshold. All pending commissions are paid out on the 1st of the month.

Commissions are only generated for active subscriptions. If a merchant cancels, no further commissions will be generated for that referral.

Go to the user menu (top right) and click 'Change Plan', or visit `/change-plan` directly.

Launch Amethyst Grid Now →

***

If you can't find what you're looking for, click here to contact our support team directly at [support@amethystapps.com](mailto:support@amethystapps.com).

# Amethyst Grid FAQ
Source: https://amethystapps.com/guides/amethyst-partners-faq

Everything you need to know about Amethyst Grid affiliate mechanics, programmatic operations, and billing infrastructure.

## General

Amethyst Grid is an affiliate marketing platform built for Shopify app owners and merchants. It lets you run a fully automated affiliate program — track clicks, manage partners, and pay out 20% recurring commissions via Stripe Connect.

It's for two types of users: Affiliates who want to earn commissions by referring Amethyst Apps to Shopify merchants, and Program Owners who want to run their own affiliate program.

The Affiliate plan is completely free to join. The Program Owner plan costs £10/month with no free trial, but you can cancel at any time.

You can promote any of the active Amethyst Apps listed in your dashboard, including Agent Ready, Index Pulse, IndexStream, Search Pulse, and more.

## Affiliates

Sign up, choose the Affiliate plan, go to Amethyst Apps in your dashboard, select the apps you want to promote, and copy your unique tracking links to share.

You earn 20% of every monthly subscription you refer, recurring for as long as the merchant stays subscribed. There is no cap on earnings.

Each affiliate gets a unique tracking link. When a merchant clicks your link and subscribes to an app, the commission is automatically attributed to your account.

Yes. You must connect a Stripe account via Stripe Connect in your Partner Profile to receive payouts. This is a one-time setup.

Stripe Connect onboarding typically takes 5–10 minutes. You will need a valid bank account and some basic identity information.

Your commissions will accumulate and remain as Pending. They will be paid out on the next 1st-of-month payout run after you complete Stripe onboarding.

## Program Owners

£10/month, billed monthly via Stripe. Cancel any time.

Yes. From the Program Dashboard, go to Partners and click Invite Partner. Your invitees will receive an email with a link to join your program.

Yes. The Program Dashboard gives you a full overview of all affiliate activity, clicks, commissions, and payout history across your entire program.

Currently the commission rate is fixed at 20% for all Amethyst Apps affiliates. Custom rates are on our roadmap.

Your program will stay active until the end of the current billing period. After that, partner tracking links will stop generating new commissions.

## Payouts

Payouts are processed automatically on the 1st of every month for all commissions with a Pending status.

Payouts are made in the currency of your connected Stripe account, typically GBP or USD depending on your location.

There is currently no minimum payout threshold. All pending commissions are paid on the 1st of each month.

Yes. Go to My Commissions in your dashboard to see a full history of paid and pending commissions with dates and amounts.

If a payout fails, it will remain as Pending and retry on the next scheduled payout run. Check your Stripe account is fully verified if you experience repeated failures.

## Account

Yes. Go to the user menu and click Change Plan at any time. Switching is instant.

Yes. Choose the 'Both' plan to access both the affiliate dashboard and the program owner dashboard from one account.

On the sign-in page, click 'Forgot password?' and follow the instructions sent to your email.

Email [support@amethystapps.com](mailto:support@amethystapps.com) with your request. We aim to process deletion requests within 5 business days.

Yes. All data is encrypted in transit and at rest. Passwords are hashed and never stored in plain text. Payment data is handled entirely by Stripe and never stored on our servers.

Launch Amethyst Grid Portal →

***

If you can't find what you're looking for, click here to contact our support team directly at [support@amethystapps.com](mailto:support@amethystapps.com).

# Shopify Apps
Source: https://amethystapps.com/guides/app-gallery

# Optimized Storefront Tools Built for PageSpeed

We build boutique software solutions designed to increase conversion and simplify store management. Our apps ensure zero impact on your PageSpeed scores across **BigCommerce** and **Shopify**.

View Our Live Shopify Apps →

***

## Our Apps

Prepare your store for the AI-commerce revolution with optimized feeds and readiness scores.

Monitor Google indexing status and automatically submit product URLs for faster search visibility.

Automate custom notice banners and store-wide alerts on product pages without touching code.

Increase AOV with AI-powered visual recommendations and "Complete the Set" bundle offers.

Real-time search intent tracking and automated keyword optimization for your storefront.

Automatically assign products to shipping profiles based on custom weight, price, or vendor rules.

Real-time security monitoring, audit logs, and auto-reverts to protect your store from unauthorized changes.

The ultimate multi-platform toolkit. Toggle Anti-Copy, Free Shipping Bars, and Trust Badges with zero coding.

Automatically back up your store's themes and media assets to 19+ cloud storage providers you control.

Generate AI-powered alt text for product videos to dominate Google Video search results.

***

## Why Amethyst?

In 2026, speed is the only feature that matters.

Amethyst wasn’t born in a boardroom; it was started by active **ecommerce sellers** who understand the need for **high-conversion storefront tools**. We build the **BigCommerce and Shopify apps** we actually use in our own stores, focused on **lightning-fast search**, real customer benefits, and **affordable app subscriptions** that won't eat into your profit margins. We believe every **eCommerce business** deserves pro-level tools without the "enterprise" price tag.

# Changelog Roadmap
Source: https://amethystapps.com/guides/changelog-roadmap

The current development status for the Amethyst suite.

## App Pipeline

Tracking the progress of our boutique tools from development to the Shopify and BigCommerce app stores.

| App Name | Status | Notes | |
| :------------------------------ | :------------------- | :----------------------------------- | ------------------------------------------------------------------------------------------- |
| **Agent Ready** | 3. Gone Live Shopify | Optimized for AI-commerce readiness. | |
| **IndexPulse** | 3. Gone Live Shopify | Google indexing automation. | |
| **Noticeable** | 2. In For Review | Automated store notices. | |
| **OpticMatch** | 1. Under Development | AI visual upsells. | |
| **Search Pulse** | 3. Gone Live Shopify | Search intent tracking. | |
| **Shipping Profile Automator** | 3. Gone Live Shopify | Shipping rule automation. | |
| **Store Sentry** | 1. Under Development | Security and audit logs. | |
| **Toggleboard: Seller Connect** | 3. Gone Live Shopify | Multi-tool toggle kit. | 3 Toggles Added 14/5/26 - Sticky Add to Cart, Cart Reservation Timer & Scroll Progress Bar. |
| **VaultStream** | 2. In For Review | Cloud backups and media sync. | |
| **Video SEO Alt Tags** | 3. Gone Live Shopify | AI video metadata optimization. | |

***

> **Workflow Key:**
>
> 1. **Under Development:** Internal coding and testing phase.
> 2. **In For Review:** Submitted to Shopify/BigCommerce for platform approval.
> 3. **Gone Live:** Fully released and available for installation.

# IndexPulse Guide
Source: https://amethystapps.com/guides/index-pulse

Configure IndexPulse to monitor your store's indexing status and automatically submit URLs to Google and Bing.

## Installation Guide

### 1. Find the App

Search for "**IndexPulse**" on the **Shopify App Store** or **BigCommerce App Marketplace**. You can also find the app by searching for "Google Indexing" or "SEO Indexer" in the search category.

View App Details →

### 2. Install the App

Click the "Install" or "Add app" button. Review the permissions — the app requires access to read and write product metadata (Metafields) to trigger the "Pulse" signal and track indexing status. Click to proceed with the installation.

### 3. Connect to Google

Navigate to the **IndexPulse Dashboard**. You must connect your Google Account via OAuth. Ensure the account you connect has "Owner" or "Full" permissions for your store in **Google Search Console**.

### 4. Initial Scan (Force Sync)

Once connected, click the **"Force Sync"** button. IndexPulse will pull your product list and check every URL against the Google Search Console API to determine its current indexing status.

***

## How to Use

### Dashboard Overview

Your command center displays the real-time "heartbeat" of your search presence:

* **Google Connection** — Shows **Connected** or **Action Required** (authentication status).
* **Queue Summary** — Counts of products waiting for indexing (**Ready**), currently being processed (**Processing**), or finished (**Done**).
* **Index Rate** — A percentage showing how much of your catalog is live in Google Search.

### The Indexing Queue

Any product URL that returns a "Not Indexed" or "Neutral" status from Google is automatically added to the Queue.

* **Priority Score:** Every unindexed product starts with a baseline score.
* **Persistence Tracking:** If a URL remains unindexed after a "Pulse," its priority increases, moving it to the front of the line for the next run.
* **Manual Actions:** You can manually re-queue or remove specific URLs from the **Queue** tab.

### Run Pulse (The Submission Pipeline)

Click **"Run Pulse"** (or wait for the automatic daily run) to trigger the indexing sequence:

1. **Google Indexing API:** Sends a direct "URL Updated" notification to Google's priority crawl queue.
2. **IndexNow:** Submits the URL in bulk to Bing and other supported search engines.
3. **Metadata "Ping":** Writes a `last_ping` timestamp to the product. This signals a change to your store platform, which often triggers a natural crawl from search bots.

### Plans & Billing

IndexPulse offers flexible plans based on your store size and submission requirements. All billing is handled securely through your respective platform (**Shopify Admin** or **BigCommerce Billing**).

***

## Verify in Search Console

You can verify the app's work directly in your Google Search Console account:

1. Open GSC and go to the **URL Inspection** tool.
2. Paste a product URL that IndexPulse has marked as "Done."
3. You should see "URL is on Google" or a "Crawl Requested" timestamp that matches your **CrawlLog** in IndexPulse.

***

## Tips & Best Practices

* **Monitor the Priority Score:** If a product reaches a high priority score, it means search engines are repeatedly ignoring it. Check for "Broken Links" or "Duplicate Content" issues.
* **Verify Domain Ownership:** If the app says "GSC Permission Denied," ensure the email you used for OAuth is the same one listed as a verified owner in Search Console.
* **Check the CrawlLog:** View the history of every "Pulse" to see the exact time and channel (Google vs. Bing) used for submission.

**Pro Tip: The "Pulse" Advantage**

Unlike standard sitemaps which search engines might crawl only once a week, the **IndexPulse** pipeline uses active notifications. By combining high-priority APIs with a physical metadata update on your store, you create a "high-priority signal" that forces search engines to re-evaluate the page much faster than usual.

### Need Support?

If you are having trouble connecting your Google Search Console account or have questions about daily limits, our engineering team is ready to help.
[Contact Amethyst Support](mailto:support@amethystapps.com)

Start Indexing with IndexPulse Now →}}