Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1465766489.0 KB

Starts a recommendation job that analyzes agent traces and generates optimization suggestions for system prompts or tool descriptions to improve agent performance.

post/recommendations

Request body

namestring required

The name of the recommendation. Must be unique within your account.

descriptionstring

The description of the recommendation.

type'SYSTEM_PROMPT_RECOMMENDATION' | 'TOOL_DESCRIPTION_RECOMMENDATION' required

The type of recommendation to generate.

kmsKeyArnstring

The ARN of the KMS key used to encrypt recommendation data. If provided, customer data is encrypted at rest with the specified key.

clientTokenstring

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.

tagsobject

A map of tag keys and values to associate with the recommendation.

Response

Success

recommendationIdstring required

The unique identifier of the created recommendation.

recommendationArnstring required

The Amazon Resource Name (ARN) of the created recommendation.

namestring required

The name of the recommendation.

descriptionstring

The description of the recommendation.

type'SYSTEM_PROMPT_RECOMMENDATION' | 'TOOL_DESCRIPTION_RECOMMENDATION' required

The type of recommendation.

status'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'DELETING' required

The status of the recommendation.

createdAtstring date-time required

The timestamp when the recommendation was created.

updatedAtstring date-time required

The timestamp when the recommendation was last updated.