Documentation

Getting started

Install the app from the Shopify App Store. OAuth runs automatically and the dashboard opens with the Free plan (10 products per month).

1. Connect an AI provider — choose one of the available providers and paste your API key (see provider setup guides below).
2. Run your first analysis — use "Analyze products". Deterministic analysis works even before you connect a provider.
3. Review the findings — each product shows a content score, findings and an optimization opportunity.
4. Copy improvements — improved title, description and tags are grounded in your product facts.

Understanding findings

Each finding explains what is wrong and why it matters — for example a generic title, a thin description or missing tags. Findings are grouped by product, and results are labelled:

• AI-assisted — the AI enrichment used your provider's model on your key.
• Deterministic — computed locally by quality rules (no AI call).

Copying improved content

Use the Copy buttons next to the improved title, description and tags. The app is read-only: it never writes to your Shopify catalog automatically.

What BYOK means

Bring Your Own Key. You supply your own AI provider API key. AI requests are sent to the provider you configure, and that provider bills you directly. The app:

• encrypts your key at rest and never returns it to the browser;
• never logs your key;
• adds no AI markup and sells no AI credits;
• never silently switches you to another provider.

Supported providers

BAIFPO is BYOK: connect your own API key. Connectable today: OpenRouter, Google Gemini, OpenAI, Anthropic, Groq and NVIDIA. DeepSeek, Mistral, Groq, Perplexity (Sonar API) and NVIDIA are connectable. Each provider uses its own official API and key format; free tiers and limits are controlled by each provider and can change.

• OpenRouter — many models, one OpenAI-compatible key. Free models may be available.
• DeepSeek — low-cost reasoning models.
• Google Gemini — free tier may be available.
• OpenAI — premium GPT models.
• Mistral — European model family.
• Anthropic — premium Claude models.
• NVIDIA — hosted NVIDIA models; free endpoints where available.
• Groq — very fast inference; free tier may be available, limits apply.
• Perplexity (Sonar API) — research-grounded Sonar models.

Provider setup guides

API key security

Your API key, your provider account. Your AI provider account remains under your control — BAIFPO only stores the key you provide.

• Rotate API keys regularly.
• If you believe a key may have been exposed, revoke it immediately and replace it with a new key.
• You are responsible for maintaining the security of your provider account and API credentials.

• Keys are encrypted at rest (Fernet) and decrypted server-side only for a request.
• Keys are never returned to the browser, never logged, and never included in telemetry.
• Removing a provider deletes its encrypted credential.

Product analysis

The app reads product titles, descriptions and tags with the read_products scope only. It analyzes:

• clarity, completeness and structure of titles and descriptions;
• presence and usefulness of tags;
• duplicates and near-duplicates;
• factual grounding of suggested improvements.

Improved content is validated deterministically: no invented materials, dimensions, certifications or claims; numbers and brand names are preserved; HTML is sanitized.

Catalog Intelligence

Paid plans unlock catalog health, priorities, change detection, stale-analysis detection, regression detection and duplicate aggregation. On Free, these areas are locked — the app shows an "Unlock Catalog Intelligence" card instead.

Usage & limits

The allowance resets with each 30-day usage period. Re-analyzing an unchanged product does not consume extra allowance; failed analyses never count.

Billing

Plans are billed monthly through Shopify App Pricing. Upgrade, downgrade or cancel in Shopify at any time — no reinstalls required. After a plan change the app re-verifies your subscription with Shopify before applying the new entitlement. A voluntary 7-day refund for your first paid charge is available — see our Terms.

Security & privacy

• Read-only product access (read_products); no orders, customers or analytics scopes.
• BYOK credentials encrypted at rest; never exposed to the browser or logs.
• Tenant isolation: each store only ever sees its own data; uninstalling deletes the store's data.
• Product content sent to an AI provider is subject to that provider's terms and privacy policy.
• See the Privacy Policy and Terms of Service.

Troubleshooting

• Connection failed / invalid API key — check the key, its permissions and your provider account balance. Then test again.
• Provider timeout — the provider took too long; try again or choose another model.
• Analysis failed — retry; failed analyses never consume quota.
• Quota reached — you have used this period's allowance; upgrade or wait for the next period.
• Billing not updated — reopen the billing page; the app re-verifies the subscription with Shopify.
• After reinstalling — fresh approval is required before a paid plan applies; that is expected.
• Shopify authentication — reopen the app from the Shopify admin to refresh your session.

FAQ