Andi AI Search API Documentation

Documentation site for the Andi AI Search API, built on Mintlify and hosted at docs.andiai.com.

Development

Install the Mintlify CLI (requires Node.js v20.17.0+ LTS):

npm i -g mint

Run the local dev server:

mint dev

Preview at http://localhost:3000.

Validation

mint validate        # Validate documentation builds
mint broken-links    # Check internal links

Testing

API tests verify that documented parameters, response formats, and error handling match the live API.

Prerequisites: jq (brew install jq)

Setup:

cp .env.example .env    # Then add your API key

Run tests:

./tests/run-tests.sh              # All suites
./tests/run-tests.sh auth errors  # Specific suites
./tests/run-tests.sh --list       # List available suites

Mintlify validation (mint validate, mint broken-links, mint openapi-check) runs automatically at the end if the mint CLI is installed.

SEO

• OG image: docs.json → thumbnails sets the background (images/og-default.png). Mintlify auto-generates OG images with logo, title, and description overlay.
• Metatags: docs.json → seo.metatags sets og:site_name and twitter:site.
• Organization JSON-LD: organization-schema.js — injected on every page via Mintlify custom scripts. Links docs.andiai.com into the Andi entity graph.
• Robots: robots.txt — overrides Mintlify default. Explicitly allows AI crawlers (GPTBot, ClaudeBot, PerplexityBot).
• Analytics: PostHog via docs.json → integrations.posthog.

Per-page SEO in frontmatter:

• keywords: YAML array for Mintlify internal search
• noindex: true: Prevent indexing (for stub pages)

Publishing

Changes pushed to main auto-deploy via the Mintlify GitHub app.