Create an AIRecommendation

Overview

Create a new AIRecommendation.

Available for Staff tokens

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Upstream agent or partner system that produced this recommendation (for example: 'client_agent', 'lead_capture_agent', 'partner_x').

actions
array of objects
required

A list of recommended actions related to this entity.

actions*
display
object

Contains display-related information for the recommendation.

string
enum
Defaults to needs_attention

Recommendation category set by the producer for interface use: 'needs_attention' (time-sensitive and requires the user's attention) or 'opportunity' (growth-focused value opportunity that does not require immediate action).

Allowed:
string
enum
Defaults to standard

Relative ordering priority within the same category: 'high' (higher priority, surfaced first) or 'standard' (default priority).

Allowed:
string
enum
Defaults to requires_human_approval

Indicates whether this recommendation is auto-executed by an agent or requires human review: 'auto_execute' (may be executed automatically by the system or an authorized agent) or 'requires_human_approval' (must be reviewed and approved by a human before execution).

Allowed:
tags
array of strings
length ≤ 10

Optional user-facing tags that label the item's urgency, value, or context (for example: 'Hot lead', 'New', 'High value', 'Urgent', 'At risk', 'Follow up').

tags
date-time

Optional due or target time used for urgency and upcoming behavior, in ISO 8601 format.

date-time

Optional expiry time used for dismissing or clearing the recommendation, in ISO 8601 format.

context
object

The context in which the recommendation was generated.

target
object

The target entity for this recommendation, typically representing the user or business involved.

status
object
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json