Body Required

• context object Required

  User context shared across all capabilities.

  Contains cart contents, purchase history, and other signals used for personalization.

  Hide context attributes Show context attributes object

  • cart object | null

    Container for product selections.

    Partners submit products they want to generate widgets for. Can include items from user's cart, browsing history, or curated selections.

    Hide cart attributes Show cart attributes object | null

    • additionalContext object | null
      Hide additionalContext attribute Show additionalContext attribute object | null

      • * string Additional properties
    • vibes array[string] | null

      Mood/vibe for personalizing recommendations.

      Values are adventurous, budget_friendly, cozy, festive, health_conscious, indulgent, minimalist, premium, romantic, or spontaneous.

    • type string Required

      Values are grocery or fashion.

    • products array[object] Required
      Hide products attributes Show products attributes object

      Product in a cart/selection.

      Two modes supported:

      1. Catalog reference (minimal): Only product_id required. Backend hydrates details.
      2. Inline (legacy): Full product details provided directly.

      For catalog-based products (e.g., fashion try-on), provide product_id. Product details are fetched from the catalog database. For inline products (e.g., grocery), provide name and details directly.

      • productId string | null
      • name string | null
      • brand string | null
      • price number | null
      • category string | null
      • quantity integer

        Default value is 1.

      • size string | null
      • unit string | null
      • barcode string | null
      • organic boolean | null

        Default value is false.

      • glutenFree boolean | null

        Default value is false.

  • trip object | null
    Hide trip attributes Show trip attributes object | null

    • additionalContext object | null
      Hide additionalContext attribute Show additionalContext attribute object | null

      • * string Additional properties
    • vibes array[string] | null

      Mood/vibe for personalizing recommendations.

      Values are adventurous, budget_friendly, cozy, festive, health_conscious, indulgent, minimalist, premium, romantic, or spontaneous.

    • flight object | null
      Hide flight attributes Show flight attributes object | null

      • departureAirport string Required
      • arrivalAirport string Required
      • departureTimestamp integer Required
      • arrivalTimestamp integer Required
      • numTravelers integer Required
      • seatClass string Required

        Values are economy, main, premium, business, or first.

    • cruise object | null
      Hide cruise attributes Show cruise attributes object | null

      • departurePort string Required
      • arrivalPort string Required
      • departureTimestamp integer Required
      • arrivalTimestamp integer Required
      • numTravelers integer Required
    • latitude number | null
    • longitude number | null
    • radiusMeters integer | null
  • topic object | null
    Hide topic attributes Show topic attributes object | null

    • additionalContext object | null
      Hide additionalContext attribute Show additionalContext attribute object | null

      • * string Additional properties
    • vibes array[string] | null

      Mood/vibe for personalizing recommendations.

      Values are adventurous, budget_friendly, cozy, festive, health_conscious, indulgent, minimalist, premium, romantic, or spontaneous.

    • topic string Required
    • questions array[string] Required
  • history object | null

    User's purchase/browsing history for personalization.

    Hide history attributes Show history attributes object | null

    • additionalContext object | null
      Hide additionalContext attribute Show additionalContext attribute object | null

      • * string Additional properties
    • vibes array[string] | null

      Mood/vibe for personalizing recommendations.

      Values are adventurous, budget_friendly, cozy, festive, health_conscious, indulgent, minimalist, premium, romantic, or spontaneous.

    • orders array[object]
      Hide orders attributes Show orders attributes object

      A past order from purchase history.

      Two modes supported:

      1. Catalog reference (minimal): Only product_id required. Backend hydrates details.
      2. Inline (legacy): Full product details provided directly.

      • productId string | null
      • name string | null
      • brand string | null
      • category string | null
      • color string | null
      • purchasedAt string | null
  • customer object | null

    Known facts about an identified customer.

    Populated server-side from L2 features in customer_profiles when external_customer_id is present. Partner-supplied fields override server-derived values on conflict (escape hatch for bootstrapping).

    Hide customer attributes Show customer attributes object | null

    • additionalContext object | null
      Hide additionalContext attribute Show additionalContext attribute object | null

      • * string Additional properties
    • vibes array[string] | null

      Mood/vibe for personalizing recommendations.

      Values are adventurous, budget_friendly, cozy, festive, health_conscious, indulgent, minimalist, premium, romantic, or spontaneous.

    • external_customer_id string | null
    • lifecycle_stage string | null
    • age_range string | null
    • zip_code string | null
    • locale string | null
    • membership_tier string | null
    • purchase_summary object | null

      Additional properties are allowed.

    • engagement_summary object | null

      Additional properties are allowed.

    • benefits_activated array[string] | null
• capabilities array[object] Required

  At least one capability is required

  At least 1 element.

  One of:

  catalog_recommendations object virtual_tryon object virtual_tryon_video object wardrobe_recommendations object research object onboarding_quiz object recipes object nutrition_analysis object weekly_meal_plan object sponsored object restaurants object wearables_tracking object engagement_decision object

  Request for catalog recommendations capability.

  Hide attributes Show attributes

  • type string Required Discriminator

    Value is catalog_recommendations.

  • config object Required

    Configuration for catalog recommendations capability.

    Hide config attributes Show config attributes object

    • modelOverride string | null
    • allowedSources array[string]
    • blockedSources array[string]
    • catalogSlug string Required
    • maxResults integer

      Minimum value is 1.0, maximum value is 12.0. Default value is 6.

    • budgetMax number | null

  Request for virtual try-on capability.

  Hide attributes Show attributes

  • type string Required Discriminator

    Value is virtual_tryon.

  • config object Required

    Configuration for virtual try-on capability.

    Hide config attributes Show config attributes object

    • catalogSlug string Required

      Catalog for product validation

    • resourceIds array[string] Required

      S3 resource IDs: first is user photo, rest are wardrobe item images

      At least 1 element.

    • selectedProductIds array[string]

      Catalog product IDs to try on (optional if wardrobe items provided)

  Request for virtual try-on video capability.

  Hide attributes Show attributes

  • type string Required Discriminator

    Value is virtual_tryon_video.

  • config object Required

    Configuration for video generation from try-on image.

    Generates a short video from a virtual try-on image using Veo 3.1. The video brings the static image to life, showing the user "wearing" the products in motion.

    Hide config attributes Show config attributes object

    • sourceImageResourceId string Required

      S3 resource ID of the generated try-on image

    • animationPrompt string | null
    • durationSeconds integer

      Video duration: 4, 6, or 8 seconds

      Minimum value is 4.0, maximum value is 8.0. Default value is 4.

    • aspectRatio string

      Video aspect ratio: 16:9 or 9:16

      Default value is 9:16.

    • resolution string

      Video resolution: 720p or 1080p

      Default value is 720p.

  Request for wardrobe recommendations capability.

  Hide attributes Show attributes

  • type string Required Discriminator

    Value is wardrobe_recommendations.

  • config object Required

    Configuration for wardrobe recommendations capability.

    Analyzes a user's wardrobe (from purchase history) and recommends which accessory items complement the current outfit.

    Hide config attributes Show config attributes object

    • modelOverride string | null
    • allowedSources array[string]
    • blockedSources array[string]
    • catalogSlug string Required
    • wardrobeProductIds array[string] Required

      Product IDs from user's purchase history to analyze

      At least 1 but not more than 100 elements.

    • outfitProductIds array[string]

      Product IDs representing current outfit (from cart/selection)

    • outfitContext string | null
    • maxResults integer

      Minimum value is 1.0, maximum value is 30.0. Default value is 10.

    • minConfidence number

      Minimum value is 0.0, maximum value is 1.0. Default value is 0.5.

    • styleFilter string | null
    • categoryFilter string | null

  Request for research capability.

  Hide attributes Show attributes

  • type string Required Discriminator

    Value is research.

  • config object

    Configuration for research capability.

    Hide config attributes Show config attributes object

    • modelOverride string | null
    • allowedSources array[string]
    • blockedSources array[string]
    • maxItems integer

      Minimum value is 1.0, maximum value is 10.0. Default value is 5.

  Request for onboarding quiz capability.

  Hide attributes Show attributes

  • type string Required Discriminator

    Value is onboarding_quiz.

  • config object Required

    Configuration for onboarding quiz capability.

    Hide config attributes Show config attributes object

    • modelOverride string | null
    • allowedSources array[string]
    • blockedSources array[string]
    • goal string Required

      The goal of the quiz (e.g., 'personalize shopping experience')

    • topics array[object] Required

      Topics to generate questions for

      At least 1 element.

      Hide topics attributes Show topics attributes object

      A single quiz topic with optional predefined options.

      • name string Required

        Topic name (e.g., 'Style Preferences')

      • description string Required

        What this topic explores

      • options array[string] | null
      • allowMultiple boolean

        Allow selecting multiple options

        Default value is false.

    • style string

      Style of quiz presentation.

      Values are conversational, form, or guided.

  Request for recipes capability.

  Hide attributes Show attributes

  • type string Required Discriminator

    Value is recipes.

  • config object

    Config for recipe generation.

    Hide config attributes Show config attributes object

    • modelOverride string | null
    • allowedSources array[string]
    • blockedSources array[string]
    • maxItems integer

      Minimum value is 1.0, maximum value is 20.0. Default value is 5.

  Request for nutrition analysis capability.

  Hide attributes Show attributes

  • type string Required Discriminator

    Value is nutrition_analysis.

  • config object

    Config for nutrition analysis.

    Hide config attributes Show config attributes object

    • modelOverride string | null
    • allowedSources array[string]
    • blockedSources array[string]
    • maxItems integer

      Minimum value is 1.0, maximum value is 20.0. Default value is 5.

  Request for weekly meal plan capability.

  Hide attributes Show attributes

  • type string Required Discriminator

    Value is weekly_meal_plan.

  • config object

    Config for weekly meal plan generation.

    Hide config attributes Show config attributes object

    • modelOverride string | null
    • allowedSources array[string]
    • blockedSources array[string]
    • days integer

      Number of days to plan

      Minimum value is 1.0, maximum value is 7.0. Default value is 7.

  Request for sponsored capability.

  Hide attributes Show attributes

  • type string Required Discriminator

    Value is sponsored.

  • config object Required

    Config for sponsored capability — receives pre-populated items.

    Hide config attributes Show config attributes object

    • modelOverride string | null
    • allowedSources array[string]
    • blockedSources array[string]
    • items array[object] Required

      Items to track

      At least 1 element.

      Hide items attributes Show items attributes object

      Minimal item for sponsored tracking — just id, title, and link.

      • id string Required

        Stable item identifier

      • title string Required

        Item title for click event attribution

      • link string Required

        URL to wrap in tracking redirect

  Request for trip-based recommendation capabilities.

  Hide attributes Show attributes

  • type string Required Discriminator

    Value is restaurants.

  • config object

    Config for trip-based recommendation widgets.

    Hide config attributes Show config attributes object

    • modelOverride string | null
    • allowedSources array[string]
    • blockedSources array[string]
    • maxItems integer

      Minimum value is 1.0, maximum value is 20.0. Default value is 5.

  Request for cart-based recommendation capabilities.

  Hide attributes Show attributes

  • type string Required Discriminator

    Value is wearables_tracking.

  • config object

    Config for cart-based recommendation widgets.

    Hide config attributes Show config attributes object

    • modelOverride string | null
    • allowedSources array[string]
    • blockedSources array[string]
    • maxItems integer

      Minimum value is 1.0, maximum value is 20.0. Default value is 5.

  Request for engagement_decision capability.

  Hide attributes Show attributes

  • type string Required Discriminator

    Value is engagement_decision.

  • config object Required

    Config for engagement_decision capability — references a playbook by partner-chosen ID.

    Hide config attribute Show config attribute object

    • playbook_id string Required
• tag_id string Required

  Tag/placement identifier (e.g., 'homepage_banner', 'checkout_sidebar')

• external_customer_id string | null