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 data entities, such as Products and Content. Connected tools can search for entities and retrieve stored details without using a Dataset API Key. To protect personal data and maintain a clear GDPR boundary, this area does not return User entities.
The Entities area must be allowed in the Agent Gateway Configuration before its REST endpoints or MCP tools can be used.
Available Capabilities
| Capability | REST Endpoint | MCP Tool |
|---|---|---|
| Search Products | GET /entities/products | search_products |
| Get a Product | GET /entities/products/{Product ID} | fetch_product_by_id |
| Get a Product Variant | GET /entities/products/{Product ID}/variants/{Variant ID} | fetch_product_variant_by_id |
| Search Content | GET /entities/content | search_content |
| Get Content | GET /entities/content/{Content ID} | fetch_content_by_id |
| Search Brands | GET /entities/brands | search_brands |
| Get a Brand | GET /entities/brands/{Brand ID} | fetch_brand_by_id |
| Search Product Categories | GET /entities/product-categories | search_product_categories |
| Get a Product Category | GET /entities/product-categories/{Product Category ID} | fetch_product_category_by_id |
| Search Content Categories | GET /entities/content-categories | search_content_categories |
| Get a Content Category | GET /entities/content-categories/{Content Category ID} | fetch_content_category_by_id |
REST endpoint paths in the table are relative to:
text
https://my.relewise.com/agents/api/v1/datasets/{Dataset ID}Search for Entities
Search operations accept an optional term. Omit it to list entities. Depending on the entity type, the term can match an entity ID, display name, category display name, or Data Value. Content searches match string-based Data Values. Product searches do not inspect Variant Data Values.
Searches return compact summaries and support these optional inputs:
| Input | Description |
|---|---|
language | Case-sensitive language identifier used for matching and selecting returned display names where supported. |
excludeDisabled | Whether disabled entities are excluded. The default is true. |
limit | Maximum number of results. The default is 10, and the maximum is 25. |
Use the relevant search operation when an entity ID is unknown, then use the returned ID with the corresponding detail operation.
Retrieve Entity Details
Detail operations return stored entity properties and Data Values. A Product Variant is identified by both its parent Product ID and its Variant ID because a Variant ID is unique only within its parent Product.
Entity details can include display names, state, assortments, prices, category paths, and related entity references when those properties apply to the entity type. Products and Content that are marked as deleted may remain retrievable by ID until they are physically removed.
Each detail response contains all available Data Keys and up to 100 Data Values. The dataValuesTruncated property indicates whether the Data Values were limited. Each returned Data Value includes:
key: The case-sensitive Data Key.type: The Relewise Data Value type.valueJson: JSON-encoded text containing the stored value. Parse it according totype.
See Data Types for the supported value structures.
A Product detail response also contains all Variant IDs and up to 50 compact Variant summaries. The variantsTruncated property indicates whether the summaries were limited. Use the Product ID and a returned Variant ID to retrieve the full Variant details and Data Values.
Access Requirements
The Agent Gateway Configuration must enable the connection method you use and allow the Entities area.
REST requests and MCP connections require a valid Personal Access Token whose Dataset Scope includes the requested Dataset. See Get Started with Agent Gateway for connection and authentication instructions.