picks

Let the user pick a reference

Show the user several matching UI references side by side in their browser and let them click the one to build from. Returns a URL to open for them.

Prefer this over sending full-page images whenever the user should decide which reference to use. The picker shows real screenshots at scroll depth so they can evaluate long pages.

After calling this, tell them to choose in the picker, then call waitForPick with the pickId to get their choice and a complete build prompt.

post/api/v1/picks

Request

  • Base URL: https://screenrove.com
  • URL: https://screenrove.com/api/v1/picks
  • Auth: none declared

Request body

qstring

Search words, e.g. "pricing page", "onboarding", "empty state". The best matches become the options.

screensstring

Comma-separated screen ids to show instead of searching, e.g. from an earlier searchScreens.

productstring

Only search this product id.

kind'flow' | 'marketing' | 'product'

Only search this kind of screen.

countinteger

How many options to show when searching, 2 to 6.

goalstring

What the user is building, shown on the page and used in the build prompt, e.g. "NSDR premium upgrade page".

stackstring

Preferred stack for the build prompt.

Response

The pick page is ready.

pickIdstring
urlstring

Open this for the user.

canvasUrlstring

Experimental pan-and-zoom canvas view of the same pick.

status'pending'
nextstring

What to do next.

Changes

No recorded changes to this operation across all 1 revision of this API.