SuggestAPIDocumentation
Contact usOpen app
Agent Discovery

Make Content Agent-Discoverable

Publish products, content, and policies through a domain knowledge surface and verify agent discovery.

Copy page
Open in ChatGPTOpen with page contextOpen in ClaudeOpen with page context

Use this guide to make a merchant’s data retrievable by agents without replacing its existing storefront or commerce flow.

1. Set the domain name

Use the merchant domain name, such as shop.example.com, consistently in gateway URLs, catalog links, and operational checks.

https://agent.suggestapi.com/oks/shop.example.com

2. Index agent-relevant objects

Index more than product titles. Include the canonical URL, image, availability, price, vendor, collection, tags, product type, and structured attributes agents need to compare or filter items.

Also index customer-facing content and policies that an agent may need to retrieve or cite, such as manuals, guides, shipping information, returns information, and support articles. Keep canonical URLs current so returned objects point users back to the merchant’s source of truth.

3. Verify the domain surface

After an ingestion or publishing update, verify these routes for the domain:

curl "https://agent.suggestapi.com/oks/shop.example.com"
curl "https://agent.suggestapi.com/oks/shop.example.com/search?q=running%20shoes&mode=hybrid"
curl "https://agent.suggestapi.com/oks/shop.example.com/content"
curl "https://agent.suggestapi.com/oks/shop.example.com/policies"

Check that search results have stable IDs, correct canonical URLs, and the attributes needed for your filters. Confirm content and policies are present before asking an agent to answer questions that depend on them.

Add this tag to the merchant origin’s HTML, replacing {domain} with the merchant domain name:

<link rel="ai-catalog" href="https://agent.suggestapi.com/catalogs/{domain}/ai-catalog.json">

The catalog describes the published agent capabilities. It is not a product feed and does not expose private administration endpoints.

5. Validate discovery

Verify the domain catalog and gateway discovery documents resolve:

curl "https://agent.suggestapi.com/catalogs/shop.example.com/ai-catalog.json"
curl "https://agent.suggestapi.com/.well-known/okg.json"
curl "https://agent.suggestapi.com/.well-known/agent.json"

Use /ard/v1/search or /ard/v1/explore to validate capability discovery. Use /oks/{domain}/search to validate merchant inventory or content retrieval; these are different concerns.

Publishing latency and updates

An agent surface reflects the latest successfully published domain content, not merely a source-system edit. Allow the relevant ingestion, indexing, and publishing jobs to complete before verification. Cached responses can delay what an agent sees; during a controlled check, use the gateway’s published metadata and a representative retrieval request to confirm the new revision is live.

For changes that affect a catalog’s capabilities, domain name, or origin link, republish the domain configuration and re-check the catalog URL. For content-only changes, re-ingest the changed documents and verify the canonical object and search result after processing completes.

Update checklist

  • update the source content or product data
  • run the relevant SuggestAPI ingestion or sync
  • wait for the indexing and publishing work to finish
  • verify /oks/{domain} and a targeted /search query
  • verify /content or /policies when those objects changed
  • re-check the domain catalog if its advertised capabilities changed