Skip to main content

Module routes

Module routes 

Source
Expand description

A2UI REST routes.

Mounts at /api/uar/a2ui in the main router.

MethodPathDescription
GET/api/uar/a2ui/schemasList all registered artifact schemas
GET/api/uar/a2ui/schemas/{schema_id}Get a single schema by ID
POST/api/uar/runs/{run_id}/artifact-responseSubmit user response to an input artifact
POST/api/uar/runs/{run_id}/a2ui/test-triggerTrigger a real artifact input request for testing
POST/api/uar/runs/{run_id}/a2ui/surface-test-triggerTrigger a real A2UI surface state-patch event for testing (Change 20)
GET/api/uar/runs/{run_id}/a2ui/surface-replayReplay every surface state-patch published for this run so far (Change 20 late-join reattach)

Structs§

A2uiActionPayload
A2uiApiState
ArtifactResponsePayload
Response submitted by the user after completing an A2UI artifact form.
ContinuationHostInput
PromoteComponentPayload
SurfaceTestTriggerPayload
Request body for POST /api/uar/runs/{run_id}/a2ui/surface-test-trigger (Change 20). kind is one of "createSurface" | "updateComponents" | "updateDataModel" | "deleteSurface".
TestTriggerPayload
Request body for POST /api/uar/runs/{run_id}/a2ui/test-trigger.

Functions§

build_response_router
Build the artifact-response router (mounted at /api/uar/runs).
build_schema_router
Build the A2UI schema listing router (mounted at /api/uar/a2ui).