Skip to main content

Documentation Index

Fetch the complete documentation index at: https://www.octogen.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

This guide walks you through making your first calls to the Octogen Platform Catalog API. By the end, you will have listed your granted catalogs, searched for 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 Catalog Partner organization provisioned by Octogen
  • A Platform API key from the partner portal (see Authentication)
  • At least one catalog granted to your organization
1

Set your API key

Export your API key so it’s available to all three methods below:
export OCTO_API_KEY="octo_live_<your-key>"
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

List your catalogs

Retrieve the catalogs your organization has been granted access to. The catalog value from each result is what you pass to the search endpoint.
curl -sS https://api.octogen.ai/v1/catalogs \
  -H "Authorization: Bearer $OCTO_API_KEY"
Example response:
[
  {
    "catalog": "warrenlotas",
    "displayName": "Warren Lotas",
    "sourceBaseUrl": "https://warrenlotas.com",
    "productCount": 1248,
    "lastIndexedAt": "2026-05-19T18:04:10Z"
  }
]
An empty array means your organization has no active catalog grants. Contact Octogen to have catalogs assigned to your account.
3

Search products

Search for products in a catalog using a keyword query. Use the catalog value from the previous step.
curl -sS https://api.octogen.ai/v1/products/search \
  -H "Authorization: Bearer $OCTO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "catalog": "warrenlotas",
    "q": "women'\''s linen summer dresses",
    "limit": 5
  }'
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.
4

Look up a product by URL

Resolve any product page URL to its full canonical record — including pricing, sizing, images, and variants.
curl -sS https://api.octogen.ai/v1/products/lookup \
  -H "Authorization: Bearer $OCTO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://warrenlotas.com/products/black-hoodie"}'
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 a catalog granted to your organization. A URL from an unrecognized domain or an ungranted catalog returns a 404 error.

​
Next steps

  • Filter searches — use facets, price_min, and price_max to narrow results. See Catalog search.
  • 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 Catalog Partner MCP server to give Claude or Codex direct catalog access. See MCP overview.