# discoverGPT API Docs


- **Get Started**
- [Introduction](/docs#introduction)
- [Plans & Pricing](/docs#plans--pricing)
- [Quickstart](/docs#quickstart)
- [Wire search into your storefront](/docs#wiring-search-into-your-storefront)
- [Authentication](/docs#authentication)
- [Errors](/docs#errors)

- **Platform Overview**
- [Platform overview](/docs#platform-overview)
- [Model Context Protocol](/docs#model-context-protocol-mcp)

- **Data Model**
- [Overview](/docs#data-model)
- [Products](/docs#products)
- [User profiles](/docs#user-profiles)
- [User preferences](/docs#user-preferences)
- [Pipeline status](/docs#pipeline-status)
- [CSV format](/docs#csv-format)
- [JSON format](/docs#json-format)
- [How ingestion works](/docs#how-ingestion-and-orchestration-works)

- **Ingesting Your Data**
- [Overview](/docs#ingesting-your-data)
- [Shopify (Pull)](/docs#shopify-pull)
- [Push ingest](/docs#push-ingest)
- [Other platforms](/docs#other-platforms)
- [File ingest API (CSV/XLSX)](/docs#file-ingest-api-csv-and-xlsx)
- [Ingest quickstart](/docs#ingest-quickstart)
- [Column mapping & templates](/docs#column-mapping--templates)
- [Ingest from the dashboard](/docs#ingest-from-the-dashboard)

- **Column Mapper**
- [Overview](/docs#column-mapper)
- [Apply mapping (Node.js)](/docs#apply-a-mapping-nodejs)
- [Apply mapping (Python)](/docs#apply-a-mapping-python)

- **Search API**
- [Query response](/docs#query-response)
- [Text search](/docs#text-search)
- [Text and color search](/docs#text-and-color-search)
- [Image search](/docs#image-search)
- [Text search cache check](/docs#text-search-cache-check)
- [Text and color cache check](/docs#text-and-color-search-cache-check)
- [Max product price](/docs#max-product-price)

- **User API**
- [Create user profile](/docs#create-user-profile)
- [Get profile by email](/docs#get-profile-by-email)
- [Create preferences](/docs#create-preferences)
- [Update preferences](/docs#update-preferences)
- [Get preferences](/docs#get-preferences)
- [Random data by preferences](/docs#random-data-by-preferences)

- **Pipeline API**
- [Create pipeline status](/docs#create-pipeline-status)
- [Get pipeline status](/docs#get-pipeline-status)
- [Update pipeline status](/docs#update-pipeline-status)
- [Delete pipeline status](/docs#delete-pipeline-status)

- **Merchant API**
- [Delete merchant data](/docs#delete-merchant-data)

- **Utilities**
- [Image proxy](/docs#image-proxy)
- [Health check](/docs#health-check)
- [Demo queries](/docs#demo-queries)
- [Trending search lookups](/docs#trending-search-lookups)

- **Synonyms API**
- [Discover synonyms](/docs#discover-synonyms)
- [List synonym rules](/docs#list-synonym-rules)
- [Synonym rule statistics](/docs#synonym-rule-statistics)
- [Generate synonym rules](/docs#generate-synonym-rules)
- [Preview generated rules](/docs#preview-generated-rules)
- [Validate a discovered pair](/docs#validate-a-discovered-pair)
- [Synonym quality report](/docs#synonym-quality-report)

- **Analytics API**
- [Analytics summary](/docs#analytics-summary)
- [Record analytics event](/docs#record-analytics-event)
- [Record analytics events (batch)](/docs#record-analytics-events-batch)
- [A/B comparison](/docs#ab-comparison)
- [Resolve merchant by shop domain](/docs#resolve-merchant-by-shop-domain)

- **A/B Testing**
- [Get A/B config](/docs#get-ab-config)
- [Update A/B config](/docs#update-ab-config)

- **Example Searches**
- [Get example searches](/docs#get-example-searches)
- [Set example searches](/docs#set-example-searches)
- [Reset example searches](/docs#reset-example-searches)

- **Quality API**
- [Overview](/docs#quality-api)

- **Feeds and Visibility API**
- [Overview](/docs#feeds-and-visibility-api)
- [Feed downloads (Shopify)](/docs#feed-downloads-shopify)
- [AI Visibility and GEO](/docs#ai-visibility-and-geo)
- [Visibility score](/docs#visibility-score)
- [Visibility products](/docs#visibility-products)
- [Visibility trends](/docs#visibility-trends)
- [Visibility issues](/docs#visibility-issues)
- [Visibility readiness](/docs#visibility-readiness)
- [BYO visibility keys](/docs#byo-visibility-keys)
- [Feed health detail](/docs#feed-health-detail)
- [Health summary](/docs#health-summary)
- [Product health](/docs#product-health)
- [Enrichment quality](/docs#enrichment-quality)
- [Health issues](/docs#health-issues)
- [Public API (non-Shopify)](/docs#public-api-non-shopify)

- **Gateway API (/v1)**
- [Overview](/docs#gateway-api-v1)
- [Billing](/docs#billing)
- [Feed](/docs#feed)
- [Quality](/docs#quality)
- [Virtual Try-On](/docs#virtual-try-on)
- [Checkout (Preview)](/docs#checkout-preview--not-yet-live)
- [Product detail](/docs#product-detail)
- [Cart](/docs#cart)
- [Store Policies](/docs#store-policies)
- [MCP transport](/docs#mcp-transport)

- **Recipes**
- [Prompt recipes](/docs/prompt-recipes)

- **Integrations**
- [Claude commerce agents](/docs/storefront-backend)

- **Demos**
- [Overview](/docs#demos)
- [Demo 1 — NL shopping agent (MCP)](/docs#demo-1--natural-language-shopping-agent-mcp)
- [Demo 2 — Image search](/docs#demo-2--image-similarity-search)
- [Demo 3 — Search widget](/docs#demo-3--drop-in-search-widget)
- [Demo 4 — Virtual try-on (hosted)](/docs#demo-4--virtual-try-on-hosted)
- [Demo 5 — Build your own with MCP tools](/docs/tutorials/mcp-search-tutorial)

- **Legal**
- [Terms of Service](/docs#terms-of-service)
- [Acceptable Use & Restrictions](/docs#acceptable-use--restrictions)

- **Resources**
- [Changelog](/docs#changelog)
- [Support](/docs#support)