> ## Documentation Index
> Fetch the complete documentation index at: https://amethystapps.com/llms.txt
> Use this file to discover all available pages before exploring further.

# IndexStream Guide

## IndexStream Help

Automate search visibility and monitor indexation workflows for modern web platforms.

<CardGroup cols={2}>
  <Card title="Launch App" icon="rocket" href="https://indexstream.amethystapps.com">
    Access your data pipeline dashboard directly at **indexstream.amethystapps.com** ↗
  </Card>
</CardGroup>

### Core Workflows & Features

<AccordionGroup>
  <Accordion title="Getting Started Walkthrough">
    1. **Sign up and choose your persona:** Create your account and select Solo, Agency, or Developer to unlock tailored workflows.
    2. **Add your first site:** Go to **Sites → New Site** and enter your domain URL, sitemap XML URL, and optional `llms.txt` path.
    3. **Run your first indexing job:** Open your site detail page, select a URL from your sitemap, and click **'Index Now'** to queue it.
    4. **Monitor the job:** Head to the **Jobs** page to watch the progress state live.
    5. **Review results:** Click any completed job to view its full AI critique scores and search engine submission confirmations.
  </Accordion>

  <Accordion title="Understanding Indexing Jobs & Statuses">
    Each time you submit a URL, an indexing job runs through a pipeline: scraping your live page $\rightarrow$ processing AI content critiques $\rightarrow$ dual submission via Google Indexing API and IndexNow.

    * **Pending:** Queued and waiting to run.
    * **Running:** Currently processing in the pipeline.
    * **Complete:** Successfully submitted to search engine endpoints.
    * **Failed:** Process aborted; see the specific error message on the job detail card.
    * **Cancelled:** Manually stopped before completion.
  </Accordion>

  <Accordion title="AI Content Critique & llms.txt">
    Before submission, IndexStream's AI scrapes your page and grades it across multiple dimensions to ensure optimal indexability:

    * **Readability:** Content clarity and comprehension logic.
    * **Schema Markup:** Structure and completeness of JSON-LD / data frameworks.
    * **SEO Signals:** Verification of meta tags, header tags, and image alt text attributes.
    * **AI-crawler Friendliness:** Optimizations for discovery by LLMs.

    *Note: An `llms.txt` file (located at yourdomain.com/llms.txt) tells AI crawlers like ChatGPT and Perplexity what your site is about. IndexStream automatically detects and tracks whether your site has one.*
  </Accordion>
</AccordionGroup>

### Credits, Developer API & Accounts

<AccordionGroup>
  <Accordion title="Credit Mechanics & Top-Ups">
    Each indexing job costs exactly **1 credit**, deducted when the execution starts. Monthly subscription credits reset each billing cycle and do not roll over.

    You can purchase **Top-up packs** at any time from the Credits page. Top-up credits never expire and carry forward month-to-month. The system automatically consumes top-up packs before your plan allowance to make your monthly credits last longer.
  </Accordion>

  <Accordion title="REST API Integration">
    All developer endpoints require an API key passed via the authorization header:
    `Authorization: Bearer YOUR_API_KEY`

    * **POST `/api/index`**: Submit a single URL for indexing. Body: `{ "url": "https://yourdomain.com/page", "siteId": "123" }`. (Costs 1 credit).
    * **POST `/api/bulk-index`**: Submit multiple URLs at once. Body: `{ "urls": ["https://yourdomain.com/a", "https://yourdomain.com/b"], "siteId": "123" }`. (Costs 1 credit per URL).
    * **GET `/api/job/:id`**: Poll the status, AI critiques, and submission logs of a job by its unique ID string.
  </Accordion>

  <Accordion title="Account, Billing & Support">
    * **Profile Updates:** Change your name or account email anytime from the Profile panel.
    * **Site Management:** Edit configurations or remove assets from the site detail screen. Deleting a site permanently drops all associated job logs.
    * **Subscription Control:** Upgrade, downgrade, or cancel tiers under **Credits → Manage Plan / Cancel Plan**. Canceled plans remain fully active with available credits until the end of the current billing block.
  </Accordion>
</AccordionGroup>

***

<Card title="Still need help?" icon="envelope" href="mailto:support@amethystapps.com">
  If you have billing issues, disputes, or technical queries, contact our development team directly at **[support@amethystapps.com](mailto:support@amethystapps.com)**.
</Card>