Path parameters

• experience_id string Required

Responses

• 200 application/json

  Successful Response

  Hide response attributes Show response attributes object

  • experienceId string Required
  • status string Required

    Values are PENDING, READY, or FAILED.

  • widgets array[object] Required
    One of:

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

    Hide attributes Show attributes

    • capabilityId string Required
    • status string Required
    • currentVersion integer Required
    • heading string | null
    • errorMessage string | null
    • type string Required Discriminator

      Value is restaurants.

    • data object | null

      Widget data for trip and cart recommendation widgets.

      Additional properties are allowed.

      Hide data attributes Show data attributes object | null

      • type string Required
      • heading string Required
      • items array[object] Required
        Hide items attributes Show items attributes object

        Recommendation item for various widget types.

        • id string | null
        • title string Required

          Name of the place, product, service, or item

        • description string Required

          Detailed description with relevant details and benefits

        • address string | null
        • link string | null
        • imageSearchQuery string | null
        • imageUrl string | null
        • placeId string | null
        • lat number | null
        • lng number | null
        • photoName string | null
        • rating number | null
        • userRatingCount integer | null

    Hide attributes Show attributes

    • capabilityId string Required
    • status string Required
    • currentVersion integer Required
    • heading string | null
    • errorMessage string | null
    • type string Required Discriminator

      Value is wearables_tracking.

    • data object | null

      Widget data for trip and cart recommendation widgets.

      Additional properties are allowed.

      Hide data attributes Show data attributes object | null

      • type string Required
      • heading string Required
      • items array[object] Required
        Hide items attributes Show items attributes object

        Recommendation item for various widget types.

        • id string | null
        • title string Required

          Name of the place, product, service, or item

        • description string Required

          Detailed description with relevant details and benefits

        • address string | null
        • link string | null
        • imageSearchQuery string | null
        • imageUrl string | null
        • placeId string | null
        • lat number | null
        • lng number | null
        • photoName string | null
        • rating number | null
        • userRatingCount integer | null

    Hide attributes Show attributes

    • capabilityId string Required
    • status string Required
    • currentVersion integer Required
    • heading string | null
    • errorMessage string | null
    • type string Required Discriminator

      Value is catalog_recommendations.

    • data object | null

      Widget data for catalog_recommendations widget.

      Additional properties are allowed.

      Hide data attributes Show data attributes object | null

      • heading string Required
      • recommendations array[object] Required
        Hide recommendations attributes Show recommendations attributes object

        Single recommendation in catalog_recommendations widget.

        • productId string Required
        • product object Required

          Product data as returned by product_to_widget_dict().

          Additional properties are allowed.

          Hide product attributes Show product attributes object

          • id string Required
          • externalId string | null
          • name string | null
          • brand string | null
          • price number | null
          • originalPrice number | null
          • currency string | null
          • category string | null
          • color string | null
          • imageUrl string | null
          • thumbnailUrl string | null
          • linkUrl string | null
          • inStock boolean | null
        • reasoning string Required
        • confidence number Required
        • tags array[string]
        • accepted boolean | null
      • suggestedPrompts array[string]
      • assistantMessage string Required

    Hide attributes Show attributes

    • capabilityId string Required
    • status string Required
    • currentVersion integer Required
    • heading string | null
    • errorMessage string | null
    • type string Required Discriminator

      Value is virtual_tryon.

    • data object | null

      Widget data for virtual_tryon widget.

      Additional properties are allowed.

      Hide data attributes Show data attributes object | null

      • heading string Required
      • tryOnImageUrl string Required
      • generatedImageResourceId string Required
      • products array[object] Required
        Hide products attributes Show products attributes object

        Product data as returned by product_to_widget_dict().

        • id string Required
        • externalId string | null
        • name string | null
        • brand string | null
        • price number | null
        • originalPrice number | null
        • currency string | null
        • category string | null
        • color string | null
        • imageUrl string | null
        • thumbnailUrl string | null
        • linkUrl string | null
        • inStock boolean | null
      • wardrobeItemCount integer Required
      • generationTimeSeconds number Required

    Hide attributes Show attributes

    • capabilityId string Required
    • status string Required
    • currentVersion integer Required
    • heading string | null
    • errorMessage string | null
    • type string Required Discriminator

      Value is virtual_tryon_video.

    • data object | null

      Widget data for virtual_tryon_video widget.

      Additional properties are allowed.

      Hide data attributes Show data attributes object | null

      • heading string Required
      • videoUrl string Required
      • thumbnailUrl string Required
      • durationSeconds integer Required
      • generationTimeSeconds number Required

    Hide attributes Show attributes

    • capabilityId string Required
    • status string Required
    • currentVersion integer Required
    • heading string | null
    • errorMessage string | null
    • type string Required Discriminator

      Value is wardrobe_recommendations.

    • data object | null

      Widget data for wardrobe_recommendations widget.

      Additional properties are allowed.

      Hide data attributes Show data attributes object | null

      • heading string Required
      • outfitSummary string Required
      • recommendations array[object] Required
        Hide recommendations attributes Show recommendations attributes object

        Single recommendation in wardrobe_recommendations widget.

        • productId string Required
        • rank integer Required
        • reasoning string Required
        • confidence number Required
        • styleMatch string Required
        • colorHarmony string | null
        • tags array[string]
        • product object Required

          Product data as returned by product_to_widget_dict().

          Additional properties are allowed.

          Hide product attributes Show product attributes object

          • id string Required
          • externalId string | null
          • name string | null
          • brand string | null
          • price number | null
          • originalPrice number | null
          • currency string | null
          • category string | null
          • color string | null
          • imageUrl string | null
          • thumbnailUrl string | null
          • linkUrl string | null
          • inStock boolean | null
      • assistantMessage string Required
      • totalAnalyzed integer Required
      • totalRecommended integer Required

    Hide attributes Show attributes

    • capabilityId string Required
    • status string Required
    • currentVersion integer Required
    • heading string | null
    • errorMessage string | null
    • type string Required Discriminator

      Value is recipes.

    • data object | null

      Widget data for recipes widget.

      Additional properties are allowed.

      Hide data attributes Show data attributes object | null

      • heading string Required
      • items array[object] Required
        Hide items attributes Show items attributes object

        • name string Required
        • vibe string Required
        • heroImageQuery string | null
        • heroImageUrl string | null
        • ingredients array[object] Required
          Hide ingredients attributes Show ingredients attributes object

          • name string Required
          • amount string Required
          • inCart boolean

            Default value is false.

          • imageSearchQuery string | null
          • imageUrl string | null
        • tools array[object] Required
          Hide tools attributes Show tools attributes object

          • name string Required
          • amount string Required
          • inCart boolean

            Default value is false.

          • imageSearchQuery string | null
          • imageUrl string | null
        • steps array[string] Required
        • helperTips array[string] | null

    Hide attributes Show attributes

    • capabilityId string Required
    • status string Required
    • currentVersion integer Required
    • heading string | null
    • errorMessage string | null
    • type string Required Discriminator

      Value is nutrition_analysis.

    • data object | null

      Widget data for nutrition_analysis widget.

      Additional properties are allowed.

      Hide data attributes Show data attributes object | null

      • heading string Required
      • macros array[object] Required
        Hide macros attributes Show macros attributes object

        Macro nutrient data with current value

        • nutrient string Required

          Nutrient name

          Values are Carbs, Fat, Fiber, or Protein.

        • current integer Required

          Current amount from cart (grams)

        • unit string

          Unit of measurement

          Value is g. Default value is g.

      • distribution object Required

        Percentage distribution of macronutrients

        Hide distribution attributes Show distribution attributes object

        • carbs_percent number Required

          Percentage of total macros from carbs

        • protein_percent number Required

          Percentage of total macros from protein

        • fat_percent number Required

          Percentage of total macros from fat

        • fiber_percent number Required

          Percentage of total macros from fiber

        • total_macros_grams integer Required

          Total grams of macros (carbs + protein + fat + fiber)

      • insight object Required

        LLM-generated insights about cart's nutrition profile

        Hide insight attributes Show insight attributes object

        • summary string Required

          One sentence describing the overall macro distribution pattern

        • key_observation string Required

          Most notable characteristic (e.g., low fiber, well-balanced, etc.)

        • suggestion string Required

          Practical advice on what to add or adjust (1-2 sentences)

        • balance_tip string | null
      • items array[object] Required
        Hide items attributes Show items attributes object

        Product recommendation to improve nutrition balance

        • name string Required

          Product name

        • amount string Required

          Portion size with nutrient content (e.g., '~17g protein / 170g')

        • nutrientBenefit string Required

          Primary nutrient this boosts

          Values are Carbs, Fat, Fiber, or Protein.

        • reason string | null

    Hide attributes Show attributes

    • capabilityId string Required
    • status string Required
    • currentVersion integer Required
    • heading string | null
    • errorMessage string | null
    • type string Required Discriminator

      Value is weekly_meal_plan.

    • data object | null

      Widget data for weekly_meal_plan widget.

      Additional properties are allowed.

      Hide data attributes Show data attributes object | null

      • heading string Required
      • days array[object] Required
        Hide days attributes Show days attributes object

        Meal plan for a single day

        • dayOfWeek string Required

          Day of the week

          Values are Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, or Sunday.

        • breakfast object Required

          Meal suggestion with full recipe details

          Hide breakfast attributes Show breakfast attributes object

          • name string Required

            Meal name (e.g., 'Greek Yogurt with Berries')

          • description string Required

            Brief description (1-2 sentences)

          • prepTime string Required

            Preparation time (e.g., '15 minutes')

          • servings integer Required

            Number of servings

          • ingredients array[string] Required

            List of ingredients with amounts

          • instructions array[string] Required

            Step-by-step cooking instructions

        • lunch object Required

          Meal suggestion with full recipe details

          Hide lunch attributes Show lunch attributes object

          • name string Required

            Meal name (e.g., 'Greek Yogurt with Berries')

          • description string Required

            Brief description (1-2 sentences)

          • prepTime string Required

            Preparation time (e.g., '15 minutes')

          • servings integer Required

            Number of servings

          • ingredients array[string] Required

            List of ingredients with amounts

          • instructions array[string] Required

            Step-by-step cooking instructions

        • dinner object Required

          Meal suggestion with full recipe details

          Hide dinner attributes Show dinner attributes object

          • name string Required

            Meal name (e.g., 'Greek Yogurt with Berries')

          • description string Required

            Brief description (1-2 sentences)

          • prepTime string Required

            Preparation time (e.g., '15 minutes')

          • servings integer Required

            Number of servings

          • ingredients array[string] Required

            List of ingredients with amounts

          • instructions array[string] Required

            Step-by-step cooking instructions

        • beveragePairing object | null

          Beverage pairing suggestion (wine, cocktail, or beer)

          Hide beveragePairing attributes Show beveragePairing attributes object | null

          • type string Required

            Type of beverage

            Values are wine, cocktail, or beer.

          • name string Required

            Beverage name

          • description string Required

            Brief description of the beverage

          • pairingRationale string Required

            Why it pairs well with the meals

          • ingredients array[string] | null
          • instructions array[string] | null
          • tools array[string] | null
        • suggestedIngredients array[object]

          Ingredients to add to cart

          Hide suggestedIngredients attributes Show suggestedIngredients attributes object

          Suggested ingredient to complete a meal

          • name string Required

            Ingredient name

          • amount string Required

            Amount needed (e.g., '1 cup', '200g')

          • reason string Required

            Which meal needs this ingredient

    Hide attributes Show attributes

    • capabilityId string Required
    • status string Required
    • currentVersion integer Required
    • heading string | null
    • errorMessage string | null
    • type string Required Discriminator

      Value is research.

    • data object | null

      Widget data for research widget.

      Additional properties are allowed.

      Hide data attributes Show data attributes object | null

      • heading string Required
      • sections array[object] Required
        Hide sections attributes Show sections attributes object

        Single research section (one per question).

        • question string Required
        • answer string Required
        • sources array[object]
          Hide sources attributes Show sources attributes object

          Citation source in a research section.

          • title string Required
          • url string Required

    Hide attributes Show attributes

    • capabilityId string Required
    • status string Required
    • currentVersion integer Required
    • heading string | null
    • errorMessage string | null
    • type string Required Discriminator

      Value is onboarding_quiz.

    • data object | null

      Widget data for onboarding_quiz widget.

      Additional properties are allowed.

      Hide data attributes Show data attributes object | null

      • heading string Required
      • goal string Required
      • style string Required
      • questions array[object] Required
        Hide questions attributes Show questions attributes object

        A single quiz question for the onboarding quiz widget.

        • topicName string Required

          Display name of the topic

        • topicKey string Required

          camelCase key for SDK answer mapping

        • question string Required

          The generated question text

        • description string | null
        • options array[string] | null
        • allowMultiple boolean

          Whether multiple options can be selected

          Default value is false.

        • inputType string

          Input type: text, select, or multi_select

          Default value is text.

    Standalone widget for pre-populated sponsored items — context-agnostic.

    Hide attributes Show attributes

    • capabilityId string Required
    • status string Required
    • currentVersion integer Required
    • heading string | null
    • errorMessage string | null
    • type string Required Discriminator

      Value is sponsored.

    • data object | null

      Widget data for trip and cart recommendation widgets.

      Additional properties are allowed.

      Hide data attributes Show data attributes object | null

      • type string Required
      • heading string Required
      • items array[object] Required
        Hide items attributes Show items attributes object

        Recommendation item for various widget types.

        • id string | null
        • title string Required

          Name of the place, product, service, or item

        • description string Required

          Detailed description with relevant details and benefits

        • address string | null
        • link string | null
        • imageSearchQuery string | null
        • imageUrl string | null
        • placeId string | null
        • lat number | null
        • lng number | null
        • photoName string | null
        • rating number | null
        • userRatingCount integer | null

    Hide attributes Show attributes

    • capabilityId string Required
    • status string Required
    • currentVersion integer Required
    • heading string | null
    • errorMessage string | null
    • type string Required Discriminator

      Value is engagement_decision.

    • data object | null

      Additional properties are allowed.

• 422 application/json

  Validation Error

  Hide response attribute Show response attribute object

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

    • loc array[string | integer] Required
    • msg string Required
    • type string Required
    • input
    • ctx object