COconductorone
A 2 UI

Submit Action

Changed on

SubmitAction handles user actions on A2UI surfaces.

post/api/v1/a2ui/surfaces/{surface_id}/actions

Request

  • Base URL
    https://example.conductor.one
  • URL
    https://example.conductor.one/api/v1/a2ui/surfaces/{surface_id}/actions
  • Auth
    HTTP bearer and OAuth 2
    Client credentials
    Token URL: /auth/v1/token

Path parameters

surface_idstring required

The surfaceId field.

Request body

actionNamestring

The actionName field.

clientTimestampstring date-time nullable
contextobject

The context field.

conversationIdstring

The conversationId field.

dataModelJsonstring

The dataModelJson field.

sourceComponentIdstring

The sourceComponentId field.

Response

A2UIServiceSubmitActionResponse returns the result of an action.

acceptedboolean

The accepted field.

errorMessagestring

The errorMessage field.

Changes