Run the QuickPick layout planner
Groups supplied or catalog items into a proposed QuickPick page layout and streams the result as server-sent events. Nothing is saved; save the plan with the QuickPick create endpoint.
How to use it
- Choose the source: CSV with items matched to catalog item codes, or CATALOG with no items so the server uses active catalog items.
- Put the plan in forwardedProps.quickpickPlan with optional name, instructions and grid size, and read the response as a server-sent event stream.
- The proposed pages arrive in the show_quickpick_plan tool-call event; RUN_ERROR replaces RUN_FINISHED on failure.
- Nothing is saved: review the pages and save them with Create a quick pick configuration.
BearerAuthAuthorizationBearer <JWT>application/json- body
threadId?|Conversation ID used to group runs, echoed in the run events. Generated by the server when omitted.
runId?|ID for this run, echoed in the RUN_STARTED and RUN_FINISHED events. Generated by the server when omitted.
messages*array<>Chat history. If the plan has no instructions, the content of the last message with role user is used as the instructions.
tools*array<>Accepted for compatibility with the AG-UI run format; not used by this planner.
context*array<>Accepted for compatibility with the AG-UI run format; not used by this planner.
state?|Accepted for compatibility with the AG-UI run format; not used by this planner.
forwardedProps?Carries the plan request in quickpickPlan. Required: the run is rejected without it.
OK
text/event-stream- response
timeout?|Server-side lifetime of the event stream in milliseconds (300000, i.e. 5 minutes). You do not send this; the response body is a text/event-stream of answer events.
int64curl -X POST 'https://beta.iotoms.com/api/v1/ai/quickpick/agent' \ -H 'Content-Type: application/json' \ -d '{ "messages": [ {} ], "tools": [ {} ], "context": [ {} ]}'{ "timeout": 0}