Skip to main content

Documentation Index

Fetch the complete documentation index at: https://client-integrations-api-dev.sequen.ai/llms.txt

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

The Catalog includes items we rank for you, along with their related entities and metadata. This section defines the structure and required fields for Tables within your catalog. These schemas ensure consistency and provide a clear framework for integrating your data with our platform. We offer APIs to upload, manage, and delete items and tables, ensuring your catalog remains current. This data is used to train your models, so we encourage you to provide as many attributes as possible to enhance feature engineering and machine learning training.

​
Key concepts

ConceptDescription
TableLogical container for an entity you are uploading (products, SKUs, hotels, playlists …). You create as many as you need via the Table API or the dashboard.
ItemAn object representing one entity instance. Must include all reserved fields plus any number of custom fields.
Reserved FieldsCanonical keys understood by the platform (id, timestamps, status flags…). Never rename or repurpose them.
Custom FieldsWhatever attributes you like—string, number, boolean, array<string>, time, embedding.
Relationship Column TypeSpecial column type whose value = primary key of another table, giving you 1-to-1 or 1-to-many joins out-of-the-box.

​
Item Schema

Items represent the primary entities in your catalog, such as products, variants, categories or data entities. Each Item must have a unique identifier and include relevant attributes (e.g., description, price, tags). Providing rich metadata improves catalog quality and enables advanced features like personalization and analytics.

​
Reserved Fields

FieldTypeRequiredDescription
idstringYesUnique ID for your item.
created_attimeAdded on first ingest if absent.
updated_attimeOverwritten on each upsert.
is_deletedbooleanSoft-delete marker (default false).
_tablestringautoSystem-assigned; the table the row lives in.
Example: 
{
  "id": "item-1001",
  "name": "Pro Analytics Subscription",
  "groups": ["subscriptions", "analytics-suite"],
  "description": "Advanced analytics tools for business intelligence.",
  "price": "299.00",
  "currency": "USD",
  "url": "https://yourcompany.com/products/pro-analytics",
  "tags": ["analytics", "subscription", "enterprise"],
  "created_at": "2025-05-14T09:12:33Z",
  "updated_at": "2025-05-14T09:12:33Z",
  "is_deleted": false,
  "_table": "products"
}

​
API Examples

​
Create or Update a Table

curl -X PUT https://api.sequen.com/v1/catalog/table \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "table_name": "products",
    "description": "Primary product catalog table",
    "relations": [
      { "field": "merchant_id", "relation_table": "merchants" }
    ]
  }'

​
Create or Update an Item

curl -X PUT https://api.sequen.com/v1/catalog/item \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "item-1001",
    "name": "Pro Analytics Subscription",
    "groups": ["subscriptions", "analytics-suite"],
    "description": "Advanced analytics tools for business intelligence.",
    "price": "299.00",
    "currency": "USD",
    "url": "https://yourcompany.com/products/pro-analytics",
    "tags": ["analytics", "subscription", "enterprise"],
    "_table": "products"
  }'

​
Good, Better, Best Data

Our data request is divided into three tiers: Good, Better, and Best. Below, we outline the data included in each category, with “Good” covering the mandatory requirements for a baseline model, while “Better” and “Best” provide additional data to enhance performance.
AttributeWhat Is It?GoodBetterBest
operator_id✅✅✅
category/group✅✅✅
name✅✅✅
created_date✅✅✅
updated_date✅✅✅
address✅✅✅
itinerary✅✅✅
reviews✅✅✅
awards✅✅✅
price/price_level✅✅✅
availability✅✅✅
attraction_age_range✅✅✅
attraction_duration✅✅✅
attraction_live_guide_languages✅✅✅
promo_tags✅✅✅
related_item_ids✅✅
embeddings✅✅
tags_from_models✅✅
ranking_data✅✅
seasonality✅✅
cancellation_policy✅✅
image_data✅✅
photo_count✅✅
attraction✅✅
Next, learn about Users →