# Octogen

- [Choose the right org type](https://www.octogen.ai/docs/organization-setup.md): Choose the right organization type: `Developer` or `Merchant`.
- [Octogen for developers](https://www.octogen.ai/docs/introduction.md): Octogen provides an API to access structured & enriched ecommerce product data— search products, find similar items, look up products by URL, and power AI agent integrations.
- [Authenticate with the Octogen Platform API](https://www.octogen.ai/docs/authentication.md): Learn how to create a Platform API key, configure OCTO_API_KEY in your environment, and send it as a Bearer token to authenticated endpoints.
- [Get started with Octogen in minutes](https://www.octogen.ai/docs/quickstart.md): Go from zero to your first product search result: set up your API key, search active crawled catalogs, and look up a product by URL.
- [Octogen Python SDK — async HTTP client API reference](https://www.octogen.ai/docs/sdks/python.md): Install the async Python SDK for Octogen, set your API key, and search or look up products across active crawled catalogs with typed Pydantic models.
- [Octogen TypeScript SDK — async client API reference](https://www.octogen.ai/docs/sdks/typescript.md): Install the TypeScript SDK for Octogen, set your API key, and search or look up products across active crawled catalogs with full ESM type safety in Node.js.
- [Octogen CLI](https://www.octogen.ai/docs/cli/overview.md): Use Octogen's product lookup, search, similarity, coverage, and voyage APIs from a terminal or an agent workflow.
- [Connect AI agents to Octogen via MCP](https://www.octogen.ai/docs/mcp/overview.md): Let AI coding tools search and look up products in your granted Octogen catalogs using the Model Context Protocol — no API keys required.
- [Use Octogen with Claude Code via MCP](https://www.octogen.ai/docs/mcp/claude-code.md): Register the Octogen MCP server in Claude Code with one command, then let your agent search and look up products from active crawled catalogs.
- [Use Octogen with Claude Desktop via MCP](https://www.octogen.ai/docs/mcp/claude-desktop.md): Bridge Claude Desktop to the Octogen MCP server using the mcp-remote adapter — edit one config file, restart the app, and sign in once.
- [Use Octogen with Codex CLI via MCP](https://www.octogen.ai/docs/mcp/codex-cli.md): Connect Codex CLI to Octogen using its dedicated compatibility endpoint, then sign in once to give your agent access to active crawled catalogs.
- [Search products across Octogen catalogs](https://www.octogen.ai/docs/guides/catalog-search.md): Learn how to search products across active crawled catalogs, filter by facets like color and category, and apply price ranges using the Octogen Catalog API.
- [Resolve a product by URL](https://www.octogen.ai/docs/guides/product-lookup.md): Resolve a product page URL from Octogen's index or, when needed, with bounded on-demand product resolution.
- [Resolve a product from HTML your users capture](https://www.octogen.ai/docs/guides/resolve-from-html.md): Turn the product page your user is viewing into the same product object Product Lookup returns — no fetch, no index, no caching.
- [Find products similar to a source product](https://www.octogen.ai/docs/guides/more-like-this.md): Use Octogen's More Like This endpoint to build related-product rails, substitutions, and similar-item recommendations from a product URL or UUID.
- [Add an ecommerce domain](https://www.octogen.ai/docs/guides/add-an-ecommerce-domain.md): Learn how to add an ecommerce domain to Octogen.
- [More Like This strategy recipes](https://www.octogen.ai/docs/guides/mlt-strategy-recipes.md): Five ready-to-use recommendation strategies for the More Like This endpoint, with real requests and live results: same-look, attribute matching, broad discovery, hybrid retrieval/ranking, and price-bounded similarity.
- [Request a product refresh](https://www.octogen.ai/docs/guides/product-refresh.md): Refresh a specific set of products by URL or UUID.
- [Subscribe to catalogs in BigQuery](https://www.octogen.ai/docs/guides/bigquery-subscribe.md): Create linked BigQuery datasets for your granted Octogen catalogs, either one listing at a time or automatically from cron.
- [Coverage API - URL Lists](https://www.octogen.ai/docs/guides/coverage-url-lists.md): URL Lists provide detailed access to Octogen catalog data via BigQuery
- [Paginate through large Octogen search results](https://www.octogen.ai/docs/guides/pagination.md): Use cursor-based pagination to iterate through all matching products in an Octogen search, page by page, without missing or duplicating results.
- [Handle Octogen API errors in your integration](https://www.octogen.ai/docs/guides/error-handling.md): Understand the Octogen error model, SDK exception types, and recovery strategies for auth failures, missing resources, and validation errors.
- [Stay within Octogen's API rate limits](https://www.octogen.ai/docs/guides/rate-limits.md): Understand Octogen's per-organization rate limit, the X-RateLimit headers and 429 responses on the REST API, the equivalent MCP error, and how to back off correctly.
- [FAQ](https://www.octogen.ai/docs/guides/faq.md): Frequently asked questions about Octogen.
- [Platform Catalog API v1 overview](https://www.octogen.ai/docs/api-reference/overview.md): REST API reference for the Octogen Platform Catalog API v1 - base URL, authentication, endpoints, error codes, and OpenAPI spec link.
- [GET /domains — list covered domains](https://www.octogen.ai/docs/api-reference/list-domains.md): List every domain covered by an active Octogen catalog and cache the result with ETag revalidation.
- [GET /me — inspect your API identity and limits](https://www.octogen.ai/docs/api-reference/get-me.md): Return the organization, API-key metadata, voyage quotas, and rate-limit status associated with your calling credential.
- [POST /products/lookup — resolve a product URL](https://www.octogen.ai/docs/api-reference/lookup-product.md): POST /products/lookup resolves a product URL from Octogen's index or with bounded on-demand product resolution.
- [POST /products/resolve-from-html — resolve a product from page HTML](https://www.octogen.ai/docs/api-reference/resolve-product-from-html.md): POST /products/resolve-from-html extracts a product from HTML you supply, with no index read and no outbound fetch.
- [POST /products/more-like-this — find similar products](https://www.octogen.ai/docs/api-reference/more-like-this.md): Find products similar to a source product — identified by URL, UUID, or an image — across all active crawled catalogs, or restricted to a catalog allowlist, using product enrichment and relative price preferences.
- [POST /products/refresh - refresh products](https://www.octogen.ai/docs/api-reference/refresh-products.md): POST /products/refresh requests a fresh update for one or more product URLs or UUIDs across active crawled catalogs.
- [POST /products/search — search catalog products](https://www.octogen.ai/docs/api-reference/search-products.md): Searches products across all active crawled catalogs, or within one catalog when scoped, using free-text queries, structured facet filters, price ranges, and cursor-based pagination.
- [POST /voyage — request domain coverage](https://www.octogen.ai/docs/api-reference/start-voyage.md): Start or join a voyage that adds an ecommerce domain to Octogen's catalog coverage.
- [GET /voyage/{task_id} — get voyage progress](https://www.octogen.ai/docs/api-reference/get-voyage.md): Poll the status, phase, progress, and result of a voyage requested by your organization.
- [GET /voyage — list voyages](https://www.octogen.ai/docs/api-reference/list-voyages.md): List the voyages requested by your organization and inspect current voyage quota usage.
- [POST /coverage/url-lists — create a URL list](https://www.octogen.ai/docs/api-reference/create-url-list.md): Create a named coverage URL list that Octogen joins against its crawled catalogs and shares back in BigQuery.
- [GET /coverage/url-lists — list your URL lists](https://www.octogen.ai/docs/api-reference/list-url-lists.md): Enumerate your organization's coverage URL lists with cursor pagination.
- [GET /coverage/url-lists/{urlListId} — get a URL list](https://www.octogen.ai/docs/api-reference/get-url-list.md): Fetch one coverage URL list, including its BigQuery listing details and last export status.
- [DELETE /coverage/url-lists/{urlListId} — delete a URL list](https://www.octogen.ai/docs/api-reference/delete-url-list.md): Permanently delete a coverage URL list and tear down its BigQuery resources.
- [POST /coverage/url-lists/{urlListId}/urls — add URLs](https://www.octogen.ai/docs/api-reference/add-url-list-urls.md): Add product URLs to a coverage URL list with per-URL accepted/rejected outcomes.
- [POST /coverage/url-lists/{urlListId}/urls/remove — remove URLs](https://www.octogen.ai/docs/api-reference/remove-url-list-urls.md): Remove product URLs from a coverage URL list.
- [POST /coverage/url-lists/{urlListId}/urls/contains — check URLs](https://www.octogen.ai/docs/api-reference/check-url-list-urls.md): Check which URLs are members of a coverage URL list.
- [GET /coverage/url-lists/{urlListId}/urls — enumerate URLs](https://www.octogen.ai/docs/api-reference/list-url-list-urls.md): Page through a coverage URL list's member URLs in stable insertion order.
- [Product data models: search items and full views](https://www.octogen.ai/docs/api-reference/models/product.md): Reference for MerchantProductListItem returned by search and MerchantProductView returned by lookup, including all fields and example JSON.
- [Changelog](https://www.octogen.ai/docs/changelog/overview.md): New features, improvements, and fixes for the Octogen Platform.