MoEngage · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for MoEngage Recommendation Recommendations API

3 actions 3 updates phrasing extends openapi/moengage-recommendations-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for MoEngage's API. It is a proposal applied on top of the contract, not a document MoEngage publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/recommendations/{recommendations_id}'].get

$.paths['/recommendations/{recommendations_id}/items'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for MoEngage Recommendation Recommendations API
  version: 1.0.0
extends: openapi/moengage-recommendations-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/recommendations/{recommendations_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a recommendation setup's details
      effect: read
      questions:
      - What model type and status does a recommendation setup use?
      - When was a given recommendation configuration last updated?
      instructions:
      - text: Get the details of recommendation {recommendations_id}.
        slots:
          recommendations_id: path.recommendations_id
      - text: Show the model and status of recommendation {recommendations_id}.
        slots:
          recommendations_id: path.recommendations_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/recommendations/{recommendations_id}/items'].post
  update:
    x-apievangelist-phrasing:
      intent: Get recommended items for a user
      effect: read
      questions:
      - How do I get the products recommended for a specific user?
      - Can I get recommendations based on an item the user is viewing?
      instructions:
      - text: Get recommendations from {recommendations_id} of type {RECOMMENDATION-TYPE} for user {user_id}.
        slots:
          recommendations_id: path.recommendations_id
          RECOMMENDATION-TYPE: header.RECOMMENDATION-TYPE
          user_id: requestBody.user_id
      - text: Recommend items like {item_id} to user {user_id} using {recommendations_id}.
        slots:
          item_id: requestBody.item_id
          user_id: requestBody.user_id
          recommendations_id: path.recommendations_id
      method: generated
      generated: '2026-10-01'