Skip to main content
This guide walks you through making your first calls to the Octogen Platform Catalog API. By the end, you will have searched products and resolved a product page URL to a full product record — using curl, the Python SDK, or the TypeScript SDK.

Prerequisites

Before you start, make sure you have:
  • A Developer organization provisioned by Octogen
  • A Platform API key from Octogen Platform (see Authentication)
1

Set your API key

Export your API key so it’s available to all three methods below:
The Python and TypeScript SDKs read OCTO_API_KEY from the environment automatically. You can also pass the key directly to the client constructor — see Authentication for details.
2

Search products

Search every active crawled catalog using a keyword query. Omit catalog for policy-wide search, or pass a known active crawled catalog key to restrict the request.
The response includes an items array and a nextCursor field for pagination. When nextCursor is non-null, pass it as cursor in your next request (with the same filters) to fetch the next page.
3

Look up a product by URL

Resolve any product page URL to its full product record — including pricing, sizing, images, and variants.
The lookup response includes the full product record with optional fields such as variants, categories, colors, reviews, promotions, and identifiers when the underlying catalog record has them.
The URL you pass must belong to an active crawled catalog. A URL from an unrecognized domain or unavailable catalog returns a 404 error.

Next steps

  • Filter searches — use facets, price_min, and price_max to narrow results. See Catalog search.
  • Find similar products — use a product URL or UUID as the source for More Like This recommendations. See More Like This.
  • Paginate results — use the nextCursor field to fetch subsequent pages. See Pagination.
  • Handle errors — understand 401, 403, 404, and 422 responses. See Error handling.
  • Connect an AI agent — use the Developer MCP server to give Claude or Codex direct catalog access. See MCP overview.