Skip to main content

A2uiActionIn

A UI action from an a2ui surface: the renderer's a2ui action message, as is.

versionVersionrequired

The a2ui protocol version: v1.0.

Constant value: v1.0
action objectrequired

What the user did on an a2ui surface, as the renderer reports it.

nameNamerequired

The name of the component's action.event.

Possible values: <= 64 characters, Value must match regular expression ^[^\x00-\x1f\x7f\u0085\u2028\u2029]+$

surfaceIdSurfaceidrequired

The surfaceId of the surface the component is on.

Possible values: <= 200 characters, Value must match regular expression ^[^\x00-\x1f\x7f\u0085\u2028\u2029]+$

sourceComponentIdSourcecomponentidrequired

The id of the component the user acted on.

Possible values: <= 200 characters, Value must match regular expression ^[^\x00-\x1f\x7f\u0085\u2028\u2029]+$

timestampTimestampnullable

When the user acted (ISO 8601), as the renderer reports it.

Possible values: <= 64 characters

contextobject

The context of the component's action.event with its data bindings resolved: the values the user picked or entered. At most 4000 characters as JSON, nested at most 8 levels deep.

userMessageUsermessagenullable

The component's action.event.userMessage. Taken and not used: text is what the user said.

Possible values: <= 2000 characters

metadataobjectnullable

Client-side metadata the renderer attaches. Taken and not used; bounded like context.

A2uiActionIn
{
  "version": "v1.0",
  "action": {
    "name": "string",
    "surfaceId": "string",
    "sourceComponentId": "string",
    "timestamp": "string",
    "context": {},
    "userMessage": "string",
    "metadata": {}
  }
}