Appearance
Entities Area
BETA
Agent Gateway is in BETA, and we're continuing to expand its capabilities. Your feedback helps shape what we build next—reach out to us through Relewise Support.
The Entities Area provides read-only access to Products, Variants, Content, Categories, and Brands. Search for entities and inspect their stored properties and Data Values. User entities are not available through this Area.
The Agent Gateway overview explains the available connection options. REST paths below are relative to the Dataset base URL.
Available Capabilities
| Capability | REST Endpoint | MCP Tool |
|---|---|---|
| Search Products | GET /entities/products | search_products |
| Get a Product | GET /entities/products/{productId} | fetch_product_by_id |
| Get a Product Variant | GET /entities/products/{productId}/variants/{variantId} | fetch_product_variant_by_id |
| Search Content | GET /entities/content | search_content |
| Get Content | GET /entities/content/{contentId} | fetch_content_by_id |
| Search Brands | GET /entities/brands | search_brands |
| Get a Brand | GET /entities/brands/{brandId} | fetch_brand_by_id |
| Search Product Categories | GET /entities/product-categories | search_product_categories |
| Get a Product Category | GET /entities/product-categories/{productCategoryId} | fetch_product_category_by_id |
| Search Content Categories | GET /entities/content-categories | search_content_categories |
| Get a Content Category | GET /entities/content-categories/{contentCategoryId} | fetch_content_category_by_id |
Search for Entities
Search by a term to discover entity IDs, or omit the term to list entities. Depending on the entity type, searches match IDs, display names, category display names, or Data Values. Content searches match string-based Data Values; Product searches do not inspect Variant Data Values.
Use Dataset metadata to discover a valid language when needed. Searches exclude disabled entities by default and return up to 10 results by default, with a configurable maximum of 25.
Retrieve Entity Details
Retrieve an entity by its discovered ID to inspect stored properties and Data Values. Details can include names, state, assortments, prices, category paths, and related entities, depending on the entity type. Products and Content marked as deleted may remain retrievable until physically removed.
A Product Variant requires both its parent Product ID and its Variant ID. Product details include all Variant IDs and up to 50 compact Variant summaries; variantsTruncated indicates when summaries were limited. Retrieve a Variant individually for its details.
Entity details contain all available Data Keys and up to 100 Data Values; dataValuesTruncated indicates when values were limited. Values are JSON-encoded in valueJson and should be interpreted using the returned Data Type.
For complete inputs and response schemas, use the API reference or MCP tool discovery.