Skip to main content
Applies user attributes to the embed user. In the Embed URL Builder, this is the User attributes field.

​
Syntax

​
Properties

​
object
An object containing user attributes, specified as "<user_attribute_reference>": "<value>".

​
Behavior

Each embed sign-in deletes user attributes that aren’t in userAttributes. To keep an attribute, include it on every request. See How sessions update embed users for more information.

​
Examples

​
With and without encoding

In the v1 signed payload format, send the value as JSON:
v1 payload

​
Manage AI credit limits

Use the omni_ai_credit_limit user attribute to set an individual user credit limit for the user.
Set the omni_ai_credit_limit value to a number to limit the user to that number of credits:
v1 payload