SuggestAPIDocumentation
Contact usOpen app
Agent Discovery

Agent Gateway

Use the domain knowledge surface to retrieve, compare, recommend, and hand off merchant content for agent experiences.

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

The Agent Gateway supports agent experiences while preserving the merchant’s existing site and commerce flows.

Domain knowledge surface

Start with GET /oks/{domain} to discover a domain’s supported object types, search paths, filters, capabilities, and limits.

Endpoint Purpose
GET /oks/{domain}/search Search domain products, content, policies, and other knowledge objects.
GET /oks/{domain}/products List domain products.
GET /oks/{domain}/products/{id} Fetch a canonical product record.
GET /oks/{domain}/collections List domain collections.
GET /oks/{domain}/content List domain content objects.
GET /oks/{domain}/policies List domain policy objects.

Search modes

GET /oks/{domain}/search accepts q and supports these modes:

  • typeahead for fast prefix retrieval
  • autocomplete for richer lexical retrieval
  • search for normalized full-result retrieval
  • hybrid for the full-result path with hybrid retrieval

hybrid is the preferred mode when an agent needs ranked results rather than a narrow prefix suggestion. The endpoint also supports object type, vendor, price range (min..max), availability, collection, product type, tags, limit, and offset filters.

curl "https://agent.suggestapi.com/oks/shop.example.com/search?q=black%20boots&mode=hybrid&price=0..200&limit=10"

Agent workflows

Endpoint Purpose
POST /v1/agent/search Agent-oriented search that may apply rewriting, reranking, answer synthesis, policy lookups, and citations.
GET /v1/agent/product/{id} Fetch an agent-friendly canonical product for a domain.
POST /v1/agent/compare Compare a small set of domain objects.
POST /v1/agent/recommend Return recommendations for a domain-scoped query or task.
POST /v1/agent/cart Build a handoff to the merchant’s existing cart resources.
POST /v1/agent/checkout/guide Return a safe handoff plan for the merchant’s native checkout.

Prefer the domain surface for lightweight plugins and storefront adapters. Use agent workflows when the task needs reasoning or a structured workflow above retrieval.

Commerce safety

Cart and checkout endpoints return handoff links and metadata. They direct shoppers to the merchant’s existing cart and checkout experience; they do not place orders or process payments.

See the Agent Gateway reference for request and response schemas.