POST

/recommendations

http://personalize-runtime.{region}.amazonaws.com/recommendations

Returns a list of recommended items. For campaigns, the campaign's Amazon Resource Name (ARN) is required and the required user and item input depends on the recipe type used to create the solution backing the campaign as follows: <ul> <li> USER_PERSONALIZATION - <code>userId</code> required, <code>itemId</code> not used </li> <li> RELATED_ITEMS - <code>itemId</code> required, <code>userId</code> not used </li> </ul> <note> Campaigns that are backed by a solution created using a recipe of type PERSONALIZED_RANKING use the API. </note> For recommenders, the recommender's ARN is required and the required item and user input depends on the use case (domain-based recipe) backing the recommender. For information on use case requirements see <a href="https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html">Choosing recommender use cases</a>.

Access Token Required: API Key

Body Params

itemIdstring

The item ID to provide recommendations for. Required for <code>RELATED_ITEMS</code> recipe type.

userIdstring

The user ID to provide recommendations for. Required for <code>USER_PERSONALIZATION</code> recipe type.

contextobject

The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type.

filterArnstring

The ARN of the filter to apply to the returned recommendations. For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering Recommendations</a>. When using this parameter, be sure the filter resource is <code>ACTIVE</code>.

numResultsinteger

The number of results to return. The default is 25. The maximum is 500.

promotionsarray

The promotions to apply to the recommendation request. A promotion defines additional business rules that apply to a configurable subset of recommended items.

campaignArnstring

The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.

filterValuesobject

The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma. For filter expressions that use an <code>INCLUDE</code> element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an <code>EXCLUDE</code> element to exclude items, you can omit the <code>filter-values</code>.In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations. For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering recommendations and user segments</a>.

recommenderArnstring

The Amazon Resource Name (ARN) of the recommender to use to get recommendations. Provide a recommender ARN if you created a Domain dataset group with a recommender for a domain use case.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://personalize-runtime.{region}.amazonaws.com/recommendations' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}